From 4be5dae02ed78d0723413720307f709beab3c147 Mon Sep 17 00:00:00 2001 From: Octokit Bot <33075676+octokitbot@users.noreply.github.com> Date: Thu, 15 Feb 2024 17:50:30 +0000 Subject: [PATCH 1/3] WIP octokit/openapi updated --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index bc9f9b7e4..b0b62ae2a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/types": "^12.4.0" + "@octokit/types": "^12.5.0" }, "devDependencies": { "@octokit/core": "^5.0.0", @@ -1676,9 +1676,9 @@ "license": "MIT" }, "node_modules/@octokit/types": { - "version": "12.4.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.4.0.tgz", - "integrity": "sha512-FLWs/AvZllw/AGVs+nJ+ELCDZZJk+kY0zMen118xhL2zD0s1etIUHm1odgjP7epxYU1ln7SZxEUWYop5bhsdgQ==", + "version": "12.5.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.5.0.tgz", + "integrity": "sha512-YJEKcb0KkJlIUNU/zjnZwHEP8AoVh/OoIcP/1IyR4UHxExz7fzpe/a8IG4wBtQi7QDEqiomVLX88S6FpxxAJtg==", "dependencies": { "@octokit/openapi-types": "^19.1.0" } diff --git a/package.json b/package.json index b65bda66d..0d796bfc5 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "dependencies": { - "@octokit/types": "^12.4.0" + "@octokit/types": "^12.5.0" }, "devDependencies": { "@octokit/core": "^5.0.0", From 74de400ddab47fdda7c999fc7831a435411da687 Mon Sep 17 00:00:00 2001 From: wolfy1339 Date: Thu, 22 Feb 2024 17:19:32 -0500 Subject: [PATCH 2/3] build: @octokit/types updated --- package-lock.json | 16 ++++++++-------- package.json | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index b0b62ae2a..9992bb5bc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/types": "^12.5.0" + "@octokit/types": "^12.6.0" }, "devDependencies": { "@octokit/core": "^5.0.0", @@ -1606,9 +1606,9 @@ } }, "node_modules/@octokit/openapi-types": { - "version": "19.1.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-19.1.0.tgz", - "integrity": "sha512-6G+ywGClliGQwRsjvqVYpklIfa7oRPA0vyhPQG/1Feh+B+wU0vGH1JiJ5T25d3g1JZYBHzR2qefLi9x8Gt+cpw==" + "version": "20.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-20.0.0.tgz", + "integrity": "sha512-EtqRBEjp1dL/15V7WiX5LJMIxxkdiGJnabzYx5Apx4FkQIFgAfKumXeYAqqJCj1s+BMX4cPFIFC4OLCR6stlnA==" }, "node_modules/@octokit/request": { "version": "8.0.4", @@ -1676,11 +1676,11 @@ "license": "MIT" }, "node_modules/@octokit/types": { - "version": "12.5.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.5.0.tgz", - "integrity": "sha512-YJEKcb0KkJlIUNU/zjnZwHEP8AoVh/OoIcP/1IyR4UHxExz7fzpe/a8IG4wBtQi7QDEqiomVLX88S6FpxxAJtg==", + "version": "12.6.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.6.0.tgz", + "integrity": "sha512-1rhSOfRa6H9w4YwK0yrf5faDaDTb+yLyBUKOCV4xtCDB5VmIPqd/v9yr9o6SAzOAlRxMiRiCic6JVM1/kunVkw==", "dependencies": { - "@octokit/openapi-types": "^19.1.0" + "@octokit/openapi-types": "^20.0.0" } }, "node_modules/@pkgjs/parseargs": { diff --git a/package.json b/package.json index 0d796bfc5..285a16e95 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "dependencies": { - "@octokit/types": "^12.5.0" + "@octokit/types": "^12.6.0" }, "devDependencies": { "@octokit/core": "^5.0.0", From 3af34041e82344b67ad7b705a8f11494b3afdc1d Mon Sep 17 00:00:00 2001 From: wolfy1339 Date: Thu, 22 Feb 2024 17:19:55 -0500 Subject: [PATCH 3/3] feat: add new endpoints --- ...addCustomLabelsToSelfHostedRunnerForOrg.md | 9 +- ...ddCustomLabelsToSelfHostedRunnerForRepo.md | 8 +- docs/actions/addSelectedRepoToOrgSecret.md | 7 +- docs/actions/addSelectedRepoToOrgVariable.md | 7 +- docs/actions/approveWorkflowRun.md | 2 +- docs/actions/cancelWorkflowRun.md | 3 +- docs/actions/createEnvironmentVariable.md | 6 +- .../createOrUpdateEnvironmentSecret.md | 6 +- docs/actions/createOrUpdateRepoSecret.md | 4 +- docs/actions/createOrgVariable.md | 5 +- docs/actions/createRegistrationTokenForOrg.md | 13 +- .../actions/createRegistrationTokenForRepo.md | 16 +- docs/actions/createRemoveTokenForOrg.md | 14 +- docs/actions/createRemoveTokenForRepo.md | 16 +- docs/actions/createRepoVariable.md | 4 +- docs/actions/createWorkflowDispatch.md | 2 +- docs/actions/deleteActionsCacheById.md | 4 +- docs/actions/deleteActionsCacheByKey.md | 4 +- docs/actions/deleteArtifact.md | 3 +- docs/actions/deleteEnvironmentSecret.md | 6 +- docs/actions/deleteEnvironmentVariable.md | 6 +- docs/actions/deleteOrgSecret.md | 5 +- docs/actions/deleteOrgVariable.md | 5 +- docs/actions/deleteRepoSecret.md | 4 +- docs/actions/deleteRepoVariable.md | 4 +- docs/actions/deleteSelfHostedRunnerFromOrg.md | 7 +- .../actions/deleteSelfHostedRunnerFromRepo.md | 6 +- docs/actions/deleteWorkflowRun.md | 8 +- docs/actions/deleteWorkflowRunLogs.md | 4 +- ...ctedRepositoryGithubActionsOrganization.md | 2 +- docs/actions/disableWorkflow.md | 2 +- docs/actions/downloadArtifact.md | 3 +- docs/actions/downloadJobLogsForWorkflowRun.md | 8 +- .../actions/downloadWorkflowRunAttemptLogs.md | 8 +- docs/actions/downloadWorkflowRunLogs.md | 8 +- ...ctedRepositoryGithubActionsOrganization.md | 2 +- docs/actions/enableWorkflow.md | 2 +- docs/actions/forceCancelWorkflowRun.md | 3 +- docs/actions/generateRunnerJitconfigForOrg.md | 7 +- .../actions/generateRunnerJitconfigForRepo.md | 6 +- docs/actions/getActionsCacheList.md | 8 +- docs/actions/getActionsCacheUsage.md | 5 +- .../getActionsCacheUsageByRepoForOrg.md | 7 +- docs/actions/getActionsCacheUsageForOrg.md | 3 +- docs/actions/getAllowedActionsOrganization.md | 4 +- docs/actions/getAllowedActionsRepository.md | 2 +- docs/actions/getArtifact.md | 6 +- docs/actions/getEnvironmentPublicKey.md | 7 +- docs/actions/getEnvironmentSecret.md | 6 +- docs/actions/getEnvironmentVariable.md | 6 +- ...sDefaultWorkflowPermissionsOrganization.md | 2 +- ...onsDefaultWorkflowPermissionsRepository.md | 2 +- ...getGithubActionsPermissionsOrganization.md | 2 +- .../getGithubActionsPermissionsRepository.md | 2 +- docs/actions/getJobForWorkflowRun.md | 6 +- docs/actions/getOrgPublicKey.md | 7 +- docs/actions/getOrgSecret.md | 7 +- docs/actions/getOrgVariable.md | 7 +- docs/actions/getPendingDeploymentsForRun.md | 4 +- docs/actions/getRepoPermissions.md | 2 +- docs/actions/getRepoPublicKey.md | 5 +- docs/actions/getRepoSecret.md | 6 +- docs/actions/getRepoVariable.md | 6 +- docs/actions/getReviewsForRun.md | 4 +- docs/actions/getSelfHostedRunnerForOrg.md | 7 +- docs/actions/getSelfHostedRunnerForRepo.md | 6 +- docs/actions/getWorkflow.md | 7 +- docs/actions/getWorkflowAccessToRepository.md | 3 +- docs/actions/getWorkflowRun.md | 6 +- docs/actions/getWorkflowRunAttempt.md | 9 +- docs/actions/getWorkflowRunUsage.md | 4 +- docs/actions/getWorkflowUsage.md | 6 +- docs/actions/listArtifactsForRepo.md | 10 +- docs/actions/listEnvironmentSecrets.md | 10 +- docs/actions/listEnvironmentVariables.md | 10 +- docs/actions/listJobsForWorkflowRun.md | 11 +- docs/actions/listJobsForWorkflowRunAttempt.md | 11 +- .../listLabelsForSelfHostedRunnerForOrg.md | 7 +- .../listLabelsForSelfHostedRunnerForRepo.md | 6 +- docs/actions/listOrgSecrets.md | 9 +- docs/actions/listOrgVariables.md | 9 +- docs/actions/listRepoOrganizationSecrets.md | 8 +- docs/actions/listRepoOrganizationVariables.md | 10 +- docs/actions/listRepoSecrets.md | 8 +- docs/actions/listRepoVariables.md | 9 +- docs/actions/listRepoWorkflows.md | 10 +- docs/actions/listRunnerApplicationsForOrg.md | 7 +- docs/actions/listRunnerApplicationsForRepo.md | 6 +- docs/actions/listSelectedReposForOrgSecret.md | 9 +- .../listSelectedReposForOrgVariable.md | 9 +- ...itoriesEnabledGithubActionsOrganization.md | 6 +- docs/actions/listSelfHostedRunnersForOrg.md | 11 +- docs/actions/listSelfHostedRunnersForRepo.md | 10 +- docs/actions/listWorkflowRunArtifacts.md | 10 +- docs/actions/listWorkflowRuns.md | 10 +- docs/actions/listWorkflowRunsForRepo.md | 10 +- docs/actions/reRunJobForWorkflowRun.md | 3 +- docs/actions/reRunWorkflow.md | 4 +- docs/actions/reRunWorkflowFailedJobs.md | 4 +- ...lCustomLabelsFromSelfHostedRunnerForOrg.md | 7 +- ...CustomLabelsFromSelfHostedRunnerForRepo.md | 6 +- ...veCustomLabelFromSelfHostedRunnerForOrg.md | 7 +- ...eCustomLabelFromSelfHostedRunnerForRepo.md | 6 +- .../removeSelectedRepoFromOrgSecret.md | 5 +- .../removeSelectedRepoFromOrgVariable.md | 5 +- docs/actions/reviewCustomGatesForRun.md | 3 +- .../actions/reviewPendingDeploymentsForRun.md | 4 +- docs/actions/setAllowedActionsOrganization.md | 2 +- docs/actions/setAllowedActionsRepository.md | 2 +- ...etCustomLabelsForSelfHostedRunnerForOrg.md | 7 +- ...tCustomLabelsForSelfHostedRunnerForRepo.md | 6 +- ...sDefaultWorkflowPermissionsOrganization.md | 2 +- ...onsDefaultWorkflowPermissionsRepository.md | 2 +- ...setGithubActionsPermissionsOrganization.md | 2 +- .../setGithubActionsPermissionsRepository.md | 2 +- docs/actions/setSelectedReposForOrgSecret.md | 5 +- .../actions/setSelectedReposForOrgVariable.md | 6 +- ...itoriesEnabledGithubActionsOrganization.md | 2 +- docs/actions/setWorkflowAccessToRepository.md | 5 +- docs/actions/updateEnvironmentVariable.md | 6 +- docs/actions/updateOrgVariable.md | 5 +- docs/actions/updateRepoVariable.md | 4 +- docs/activity/getFeeds.md | 2 +- .../listEventsForAuthenticatedUser.md | 4 +- .../listNotificationsForAuthenticatedUser.md | 4 +- .../listOrgEventsForAuthenticatedUser.md | 4 +- docs/activity/listPublicEvents.md | 4 +- .../listPublicEventsForRepoNetwork.md | 4 +- docs/activity/listPublicEventsForUser.md | 4 +- docs/activity/listPublicOrgEvents.md | 4 +- docs/activity/listReceivedEventsForUser.md | 6 +- .../listReceivedPublicEventsForUser.md | 4 +- docs/activity/listRepoEvents.md | 4 +- ...stRepoNotificationsForAuthenticatedUser.md | 4 +- .../listReposStarredByAuthenticatedUser.md | 8 +- docs/activity/listReposStarredByUser.md | 8 +- docs/activity/listReposWatchedByUser.md | 4 +- docs/activity/listStargazersForRepo.md | 8 +- .../listWatchedReposForAuthenticatedUser.md | 4 +- docs/activity/listWatchersForRepo.md | 4 +- docs/activity/markThreadAsDone.md | 38 + docs/activity/starRepoForAuthenticatedUser.md | 2 +- docs/apps/addRepoToInstallation.md | 2 - ...dRepoToInstallationForAuthenticatedUser.md | 2 - docs/apps/createInstallationAccessToken.md | 75 +- docs/apps/getBySlug.md | 2 - docs/apps/listAccountsForPlan.md | 4 +- docs/apps/listAccountsForPlanStubbed.md | 4 +- ...stInstallationReposForAuthenticatedUser.md | 6 +- ...InstallationRequestsForAuthenticatedApp.md | 4 +- .../listInstallationsForAuthenticatedUser.md | 6 +- docs/apps/listPlans.md | 4 +- docs/apps/listPlansStubbed.md | 4 +- .../apps/listReposAccessibleToInstallation.md | 6 +- .../listSubscriptionsForAuthenticatedUser.md | 6 +- ...ubscriptionsForAuthenticatedUserStubbed.md | 6 +- docs/apps/listWebhookDeliveries.md | 2 +- docs/apps/removeRepoFromInstallation.md | 2 - ...epoFromInstallationForAuthenticatedUser.md | 2 - docs/apps/revokeInstallationAccessToken.md | 2 - docs/apps/scopeToken.md | 77 +- docs/billing/getGithubActionsBillingOrg.md | 2 +- docs/billing/getGithubActionsBillingUser.md | 2 +- docs/billing/getGithubPackagesBillingOrg.md | 2 +- docs/billing/getGithubPackagesBillingUser.md | 2 +- docs/billing/getSharedStorageBillingOrg.md | 2 +- docs/billing/getSharedStorageBillingUser.md | 2 +- docs/checks/createSuite.md | 4 +- docs/checks/get.md | 4 +- docs/checks/getSuite.md | 4 +- docs/checks/listAnnotations.md | 8 +- docs/checks/listForRef.md | 8 +- docs/checks/listForSuite.md | 8 +- docs/checks/listSuitesForRef.md | 8 +- docs/checks/rerequestRun.md | 4 +- docs/checks/rerequestSuite.md | 2 +- docs/checks/setSuitesPreferences.md | 3 +- docs/checks/update.md | 4 +- docs/codeScanning/deleteAnalysis.md | 7 +- docs/codeScanning/getAlert.md | 4 +- docs/codeScanning/getAnalysis.md | 12 +- docs/codeScanning/getCodeqlDatabase.md | 4 +- docs/codeScanning/getDefaultSetup.md | 4 +- docs/codeScanning/getSarif.md | 3 +- docs/codeScanning/listAlertInstances.md | 9 +- docs/codeScanning/listAlertsForOrg.md | 14 +- docs/codeScanning/listAlertsInstances.md | 9 +- docs/codeScanning/listCodeqlDatabases.md | 4 +- docs/codeScanning/listRecentAnalyses.md | 10 +- docs/codeScanning/updateAlert.md | 3 +- docs/codeScanning/updateDefaultSetup.md | 11 +- docs/codeScanning/uploadSarif.md | 7 +- ...RepositoryForSecretForAuthenticatedUser.md | 8 +- docs/codespaces/addSelectedRepoToOrgSecret.md | 3 +- .../checkPermissionsForDevcontainer.md | 4 +- .../codespaceMachinesForAuthenticatedUser.md | 4 +- docs/codespaces/createForAuthenticatedUser.md | 4 +- docs/codespaces/createOrUpdateOrgSecret.md | 5 +- docs/codespaces/createOrUpdateRepoSecret.md | 6 +- ...reateOrUpdateSecretForAuthenticatedUser.md | 6 +- .../createWithPrForAuthenticatedUser.md | 4 +- .../createWithRepoForAuthenticatedUser.md | 4 +- docs/codespaces/deleteForAuthenticatedUser.md | 4 +- docs/codespaces/deleteFromOrganization.md | 5 +- docs/codespaces/deleteOrgSecret.md | 4 +- docs/codespaces/deleteRepoSecret.md | 4 +- .../deleteSecretForAuthenticatedUser.md | 6 +- docs/codespaces/exportForAuthenticatedUser.md | 4 +- docs/codespaces/getCodespacesForUserInOrg.md | 6 +- .../getExportDetailsForAuthenticatedUser.md | 4 +- docs/codespaces/getForAuthenticatedUser.md | 4 +- docs/codespaces/getOrgPublicKey.md | 3 +- docs/codespaces/getOrgSecret.md | 5 +- .../getPublicKeyForAuthenticatedUser.md | 4 +- docs/codespaces/getRepoPublicKey.md | 7 +- docs/codespaces/getRepoSecret.md | 4 +- .../getSecretForAuthenticatedUser.md | 6 +- ...tainersInRepositoryForAuthenticatedUser.md | 8 +- docs/codespaces/listForAuthenticatedUser.md | 8 +- docs/codespaces/listInOrganization.md | 6 +- .../listInRepositoryForAuthenticatedUser.md | 8 +- docs/codespaces/listOrgSecrets.md | 10 +- docs/codespaces/listRepoSecrets.md | 9 +- ...positoriesForSecretForAuthenticatedUser.md | 6 +- .../listSecretsForAuthenticatedUser.md | 10 +- .../listSelectedReposForOrgSecret.md | 9 +- .../preFlightWithRepoForAuthenticatedUser.md | 4 +- .../codespaces/publishForAuthenticatedUser.md | 4 +- ...RepositoryForSecretForAuthenticatedUser.md | 8 +- .../removeSelectedRepoFromOrgSecret.md | 6 +- .../repoMachinesForAuthenticatedUser.md | 4 +- ...positoriesForSecretForAuthenticatedUser.md | 6 +- .../setSelectedReposForOrgSecret.md | 6 +- docs/codespaces/startForAuthenticatedUser.md | 4 +- docs/codespaces/stopForAuthenticatedUser.md | 4 +- docs/codespaces/stopInOrganization.md | 5 +- docs/codespaces/updateForAuthenticatedUser.md | 4 +- docs/copilot/addCopilotSeatsForTeams.md | 55 + docs/copilot/addCopilotSeatsForUsers.md | 55 + .../cancelCopilotSeatAssignmentForTeams.md | 17 +- .../cancelCopilotSeatAssignmentForUsers.md | 17 +- docs/copilot/getCopilotOrganizationDetails.md | 15 +- docs/copilot/getCopilotSeatDetailsForUser.md | 12 +- docs/copilot/listCopilotSeats.md | 17 +- docs/dependabot/addSelectedRepoToOrgSecret.md | 6 +- docs/dependabot/createOrUpdateRepoSecret.md | 4 +- docs/dependabot/deleteOrgSecret.md | 4 +- docs/dependabot/deleteRepoSecret.md | 4 +- docs/dependabot/getAlert.md | 4 +- docs/dependabot/getOrgPublicKey.md | 5 +- docs/dependabot/getOrgSecret.md | 4 +- docs/dependabot/getRepoPublicKey.md | 6 +- docs/dependabot/getRepoSecret.md | 4 +- docs/dependabot/listAlertsForEnterprise.md | 13 +- docs/dependabot/listAlertsForOrg.md | 12 +- docs/dependabot/listAlertsForRepo.md | 10 +- docs/dependabot/listOrgSecrets.md | 9 +- docs/dependabot/listRepoSecrets.md | 9 +- .../listSelectedReposForOrgSecret.md | 9 +- .../removeSelectedRepoFromOrgSecret.md | 6 +- .../setSelectedReposForOrgSecret.md | 6 +- docs/dependabot/updateAlert.md | 6 +- .../createRepositorySnapshot.md | 6 +- docs/gists/createComment.md | 7 + docs/gists/get.md | 7 + docs/gists/getComment.md | 7 + docs/gists/getRevision.md | 7 + docs/gists/list.md | 4 +- docs/gists/listComments.md | 11 +- docs/gists/listCommits.md | 4 +- docs/gists/listForUser.md | 4 +- docs/gists/listForks.md | 4 +- docs/gists/listPublic.md | 6 +- docs/gists/listStarred.md | 4 +- docs/gists/star.md | 2 +- docs/gists/updateComment.md | 7 + docs/git/getBlob.md | 7 +- docs/gitignore/getTemplate.md | 7 +- docs/issues/create.md | 10 +- docs/issues/createComment.md | 12 +- docs/issues/get.md | 9 +- docs/issues/getComment.md | 7 + docs/issues/list.md | 11 +- docs/issues/listAssignees.md | 4 +- docs/issues/listComments.md | 11 +- docs/issues/listCommentsForRepo.md | 11 +- docs/issues/listEvents.md | 4 +- docs/issues/listEventsForRepo.md | 4 +- docs/issues/listEventsForTimeline.md | 4 +- docs/issues/listForAuthenticatedUser.md | 11 +- docs/issues/listForOrg.md | 11 +- docs/issues/listForRepo.md | 11 +- docs/issues/listLabelsForMilestone.md | 4 +- docs/issues/listLabelsForRepo.md | 4 +- docs/issues/listLabelsOnIssue.md | 4 +- docs/issues/listMilestones.md | 4 +- docs/issues/lock.md | 2 +- docs/issues/update.md | 7 + docs/issues/updateComment.md | 7 + docs/licenses/getAllCommonlyUsed.md | 4 +- docs/licenses/getForRepo.md | 5 +- docs/migrations/listForAuthenticatedUser.md | 4 +- docs/migrations/listForOrg.md | 4 +- .../listReposForAuthenticatedUser.md | 4 +- docs/migrations/listReposForOrg.md | 4 +- docs/migrations/listReposForUser.md | 4 +- docs/orgs/addSecurityManagerTeam.md | 4 +- docs/orgs/assignTeamToOrgRole.md | 54 + docs/orgs/assignUserToOrgRole.md | 54 + docs/orgs/createCustomOrganizationRole.md | 62 + docs/orgs/createInvitation.md | 4 +- docs/orgs/createOrUpdateCustomProperties.md | 14 +- ...eOrUpdateCustomPropertiesValuesForRepos.md | 5 +- docs/orgs/createOrUpdateCustomProperty.md | 9 +- docs/orgs/deleteCustomOrganizationRole.md | 51 + ...leOrDisableSecurityProductOnAllOrgRepos.md | 9 +- docs/orgs/get.md | 10 +- docs/orgs/getAllCustomProperties.md | 2 +- docs/orgs/getCustomProperty.md | 2 +- docs/orgs/getOrgRole.md | 51 + docs/orgs/getWebhookConfigForOrg.md | 2 +- docs/orgs/list.md | 2 +- docs/orgs/listAppInstallations.md | 11 +- docs/orgs/listBlockedUsers.md | 4 +- .../listCustomPropertiesValuesForRepos.md | 4 +- docs/orgs/listFailedInvitations.md | 4 +- docs/orgs/listForAuthenticatedUser.md | 8 +- docs/orgs/listForUser.md | 4 +- docs/orgs/listInvitationTeams.md | 4 +- docs/orgs/listMembers.md | 4 +- .../listMembershipsForAuthenticatedUser.md | 4 +- docs/orgs/listOrgRoleTeams.md | 58 + docs/orgs/listOrgRoleUsers.md | 58 + docs/orgs/listOrgRoles.md | 45 + .../listOrganizationFineGrainedPermissions.md | 47 + docs/orgs/listOutsideCollaborators.md | 4 +- docs/orgs/listPatGrantRepositories.md | 9 +- docs/orgs/listPatGrantRequestRepositories.md | 9 +- docs/orgs/listPatGrantRequests.md | 9 +- docs/orgs/listPatGrants.md | 9 +- docs/orgs/listPendingInvitations.md | 4 +- docs/orgs/listPublicMembers.md | 4 +- docs/orgs/listSecurityManagerTeams.md | 4 +- docs/orgs/listWebhookDeliveries.md | 2 +- docs/orgs/listWebhooks.md | 4 +- docs/orgs/patchCustomOrganizationRole.md | 66 + docs/orgs/removeCustomProperty.md | 6 +- docs/orgs/removeSecurityManagerTeam.md | 4 +- docs/orgs/reviewPatGrantRequest.md | 5 +- docs/orgs/reviewPatGrantRequestsInBulk.md | 5 +- docs/orgs/revokeAllOrgRolesTeam.md | 48 + docs/orgs/revokeAllOrgRolesUser.md | 48 + docs/orgs/revokeOrgRoleTeam.md | 54 + docs/orgs/revokeOrgRoleUser.md | 54 + ...setPublicMembershipForAuthenticatedUser.md | 2 +- docs/orgs/update.md | 6 +- docs/orgs/updatePatAccess.md | 5 +- docs/orgs/updatePatAccesses.md | 5 +- docs/orgs/updateWebhookConfigForOrg.md | 2 +- .../deletePackageForAuthenticatedUser.md | 3 +- docs/packages/deletePackageForOrg.md | 5 +- docs/packages/deletePackageForUser.md | 5 +- ...eletePackageVersionForAuthenticatedUser.md | 5 +- docs/packages/deletePackageVersionForOrg.md | 5 +- docs/packages/deletePackageVersionForUser.md | 5 +- ...lPackageVersionsForAPackageOwnedByAnOrg.md | 6 +- ...sForAPackageOwnedByTheAuthenticatedUser.md | 6 +- ...sionsForPackageOwnedByAuthenticatedUser.md | 6 +- ...tAllPackageVersionsForPackageOwnedByOrg.md | 6 +- ...AllPackageVersionsForPackageOwnedByUser.md | 2 +- .../getPackageForAuthenticatedUser.md | 2 +- docs/packages/getPackageForOrganization.md | 2 +- docs/packages/getPackageForUser.md | 2 +- .../getPackageVersionForAuthenticatedUser.md | 2 +- .../getPackageVersionForOrganization.md | 2 +- docs/packages/getPackageVersionForUser.md | 2 +- ...ConflictingPackagesForAuthenticatedUser.md | 3 +- ...ationConflictingPackagesForOrganization.md | 3 +- ...ckerMigrationConflictingPackagesForUser.md | 3 +- .../listPackagesForAuthenticatedUser.md | 6 +- docs/packages/listPackagesForOrganization.md | 6 +- docs/packages/listPackagesForUser.md | 6 +- .../restorePackageForAuthenticatedUser.md | 2 +- docs/packages/restorePackageForOrg.md | 5 +- docs/packages/restorePackageForUser.md | 5 +- ...storePackageVersionForAuthenticatedUser.md | 2 +- docs/packages/restorePackageVersionForOrg.md | 5 +- docs/packages/restorePackageVersionForUser.md | 5 +- docs/projects/listCards.md | 4 +- docs/projects/listCollaborators.md | 4 +- docs/projects/listColumns.md | 4 +- docs/projects/listForOrg.md | 4 +- docs/projects/listForRepo.md | 4 +- docs/projects/listForUser.md | 4 +- docs/pulls/create.md | 10 +- docs/pulls/createReplyForReviewComment.md | 10 +- docs/pulls/createReview.md | 15 +- docs/pulls/createReviewComment.md | 16 +- docs/pulls/deletePendingReview.md | 7 + docs/pulls/dismissReview.md | 13 +- docs/pulls/get.md | 8 + docs/pulls/getReview.md | 7 + docs/pulls/getReviewComment.md | 9 +- docs/pulls/list.md | 21 +- docs/pulls/listCommentsForReview.md | 13 +- docs/pulls/listCommits.md | 16 +- docs/pulls/listFiles.md | 17 +- docs/pulls/listReviewComments.md | 14 +- docs/pulls/listReviewCommentsForRepo.md | 14 +- docs/pulls/listReviews.md | 13 +- docs/pulls/merge.md | 2 +- docs/pulls/submitReview.md | 7 + docs/pulls/update.md | 8 + docs/pulls/updateReview.md | 9 +- docs/pulls/updateReviewComment.md | 9 +- docs/rateLimit/get.md | 2 +- .../createForTeamDiscussionCommentInOrg.md | 6 +- .../reactions/createForTeamDiscussionInOrg.md | 6 +- docs/reactions/deleteForTeamDiscussion.md | 4 +- .../deleteForTeamDiscussionComment.md | 4 +- docs/reactions/listForCommitComment.md | 4 +- docs/reactions/listForIssue.md | 4 +- docs/reactions/listForIssueComment.md | 4 +- .../listForPullRequestReviewComment.md | 4 +- docs/reactions/listForRelease.md | 4 +- .../listForTeamDiscussionCommentInOrg.md | 8 +- docs/reactions/listForTeamDiscussionInOrg.md | 8 +- docs/repos/addAppAccessRestrictions.md | 2 +- docs/repos/addCollaborator.md | 4 +- docs/repos/cancelPagesDeployment.md | 52 + docs/repos/checkCollaborator.md | 6 +- docs/repos/compareCommitsWithBasehead.md | 11 +- docs/repos/createCommitComment.md | 9 +- docs/repos/createDeployment.md | 4 +- docs/repos/createDeploymentBranchPolicy.md | 4 +- docs/repos/createDeploymentProtectionRule.md | 6 +- docs/repos/createDeploymentStatus.md | 2 +- docs/repos/createDispatchEvent.md | 7 +- docs/repos/createForAuthenticatedUser.md | 7 +- docs/repos/createInOrg.md | 9 +- .../createOrUpdateCustomPropertiesValues.md | 65 + docs/repos/createOrUpdateEnvironment.md | 4 +- docs/repos/createOrUpdateFileContents.md | 4 +- docs/repos/createPagesDeployment.md | 16 +- docs/repos/createPagesSite.md | 4 +- docs/repos/createRelease.md | 2 +- docs/repos/createUsingTemplate.md | 7 +- docs/repos/createWebhook.md | 6 - docs/repos/delete.md | 4 +- docs/repos/deleteAnEnvironment.md | 4 +- docs/repos/deleteDeployment.md | 4 +- docs/repos/deleteDeploymentBranchPolicy.md | 4 +- docs/repos/deletePagesSite.md | 4 +- docs/repos/disableDeploymentProtectionRule.md | 6 +- docs/repos/getAllDeploymentProtectionRules.md | 6 +- docs/repos/getAllEnvironments.md | 8 +- docs/repos/getAllTopics.md | 4 +- .../getAppsWithAccessToProtectedBranch.md | 2 +- docs/repos/getBranchRules.md | 4 +- docs/repos/getCodeFrequencyStats.md | 3 + docs/repos/getCombinedStatusForRef.md | 4 +- docs/repos/getCommit.md | 12 +- docs/repos/getCommitComment.md | 9 + docs/repos/getContent.md | 51 +- docs/repos/getContributorsStats.md | 4 +- .../getCustomDeploymentProtectionRule.md | 6 +- docs/repos/getDeploymentBranchPolicy.md | 6 +- docs/repos/getEnvironment.md | 8 +- docs/repos/getLatestPagesBuild.md | 2 +- docs/repos/getOrgRuleSuites.md | 4 +- docs/repos/getOrgRulesets.md | 4 +- docs/repos/getPages.md | 2 +- docs/repos/getPagesBuild.md | 2 +- docs/repos/getPagesDeployment.md | 52 + docs/repos/getPagesHealthCheck.md | 4 +- docs/repos/getReadme.md | 5 +- docs/repos/getReadmeInDirectory.md | 5 +- docs/repos/getRelease.md | 6 +- docs/repos/getRepoRuleSuites.md | 4 +- docs/repos/getRepoRulesets.md | 4 +- docs/repos/getWebhookConfigForRepo.md | 2 +- docs/repos/listActivities.md | 6 +- docs/repos/listAutolinks.md | 13 +- docs/repos/listBranches.md | 4 +- docs/repos/listCollaborators.md | 10 +- docs/repos/listCommentsForCommit.md | 13 +- docs/repos/listCommitCommentsForRepo.md | 13 +- docs/repos/listCommitStatusesForRef.md | 4 +- docs/repos/listCommits.md | 4 +- docs/repos/listContributors.md | 4 +- .../listCustomDeploymentRuleIntegrations.md | 12 +- docs/repos/listDeployKeys.md | 4 +- docs/repos/listDeploymentBranchPolicies.md | 10 +- docs/repos/listDeploymentStatuses.md | 4 +- docs/repos/listDeployments.md | 4 +- docs/repos/listForAuthenticatedUser.md | 4 +- docs/repos/listForOrg.md | 4 +- docs/repos/listForUser.md | 6 +- docs/repos/listForks.md | 4 +- docs/repos/listInvitations.md | 4 +- .../listInvitationsForAuthenticatedUser.md | 4 +- docs/repos/listPagesBuilds.md | 6 +- .../listPullRequestsAssociatedWithCommit.md | 4 +- docs/repos/listReleaseAssets.md | 4 +- docs/repos/listReleases.md | 4 +- docs/repos/listTags.md | 4 +- docs/repos/listTeams.md | 11 +- docs/repos/listWebhookDeliveries.md | 2 +- docs/repos/listWebhooks.md | 4 +- docs/repos/removeAppAccessRestrictions.md | 2 +- docs/repos/renameBranch.md | 12 +- docs/repos/setAppAccessRestrictions.md | 2 +- docs/repos/transfer.md | 1 - docs/repos/updateCommitComment.md | 9 + docs/repos/updateDeploymentBranchPolicy.md | 4 +- docs/repos/updateInformationAboutPagesSite.md | 4 +- docs/repos/updateWebhook.md | 21 +- docs/repos/updateWebhookConfigForRepo.md | 2 +- docs/repos/uploadReleaseAsset.md | 2 +- docs/search/code.md | 6 +- docs/search/commits.md | 6 +- docs/search/issuesAndPullRequests.md | 6 +- docs/search/labels.md | 6 +- docs/search/repos.md | 6 +- docs/search/topics.md | 6 +- docs/search/users.md | 6 +- docs/secretScanning/getAlert.md | 6 +- .../secretScanning/listAlertsForEnterprise.md | 13 +- docs/secretScanning/listAlertsForOrg.md | 10 +- docs/secretScanning/listAlertsForRepo.md | 10 +- docs/secretScanning/listLocationsForAlert.md | 10 +- docs/secretScanning/updateAlert.md | 6 +- docs/securityAdvisories/createFork.md | 52 + .../createPrivateVulnerabilityReport.md | 5 + .../createRepositoryAdvisory.md | 10 +- .../createRepositoryAdvisoryCveRequest.md | 4 +- .../getRepositoryAdvisory.md | 9 +- .../listGlobalAdvisories.md | 6 +- .../listOrgRepositoryAdvisories.md | 10 +- .../listRepositoryAdvisories.md | 12 +- .../updateRepositoryAdvisory.md | 5 +- .../addOrUpdateProjectPermissionsInOrg.md | 2 +- docs/teams/addOrUpdateRepoPermissionsInOrg.md | 2 +- docs/teams/checkPermissionsForRepoInOrg.md | 2 + docs/teams/createDiscussionCommentInOrg.md | 6 +- docs/teams/createDiscussionInOrg.md | 6 +- docs/teams/deleteDiscussionCommentInOrg.md | 4 +- docs/teams/deleteDiscussionInOrg.md | 4 +- docs/teams/getDiscussionCommentInOrg.md | 4 +- docs/teams/getDiscussionInOrg.md | 4 +- docs/teams/list.md | 4 +- docs/teams/listChildInOrg.md | 4 +- docs/teams/listDiscussionCommentsInOrg.md | 8 +- docs/teams/listDiscussionsInOrg.md | 8 +- docs/teams/listForAuthenticatedUser.md | 11 +- docs/teams/listMembersInOrg.md | 4 +- docs/teams/listPendingInvitationsInOrg.md | 4 +- docs/teams/listProjectsInOrg.md | 4 +- docs/teams/listReposInOrg.md | 4 +- docs/teams/updateDiscussionCommentInOrg.md | 4 +- docs/teams/updateDiscussionInOrg.md | 4 +- docs/users/addEmailForAuthenticated.md | 2 +- docs/users/addEmailForAuthenticatedUser.md | 2 +- .../addSocialAccountForAuthenticatedUser.md | 4 +- docs/users/createGpgKeyForAuthenticated.md | 4 +- .../users/createGpgKeyForAuthenticatedUser.md | 4 +- .../createPublicSshKeyForAuthenticated.md | 4 +- .../createPublicSshKeyForAuthenticatedUser.md | 4 +- ...createSshSigningKeyForAuthenticatedUser.md | 4 +- docs/users/deleteEmailForAuthenticated.md | 2 +- docs/users/deleteEmailForAuthenticatedUser.md | 2 +- docs/users/deleteGpgKeyForAuthenticated.md | 4 +- .../users/deleteGpgKeyForAuthenticatedUser.md | 4 +- .../deletePublicSshKeyForAuthenticated.md | 4 +- .../deletePublicSshKeyForAuthenticatedUser.md | 4 +- ...deleteSocialAccountForAuthenticatedUser.md | 4 +- ...deleteSshSigningKeyForAuthenticatedUser.md | 4 +- docs/users/follow.md | 4 +- docs/users/getAuthenticated.md | 4 +- docs/users/getByUsername.md | 4 +- docs/users/getContextForUser.md | 4 +- docs/users/getGpgKeyForAuthenticated.md | 4 +- docs/users/getGpgKeyForAuthenticatedUser.md | 4 +- docs/users/getPublicSshKeyForAuthenticated.md | 4 +- .../getPublicSshKeyForAuthenticatedUser.md | 4 +- .../getSshSigningKeyForAuthenticatedUser.md | 4 +- docs/users/list.md | 2 +- docs/users/listBlockedByAuthenticated.md | 4 +- docs/users/listBlockedByAuthenticatedUser.md | 4 +- docs/users/listEmailsForAuthenticated.md | 9 +- docs/users/listEmailsForAuthenticatedUser.md | 9 +- docs/users/listFollowedByAuthenticated.md | 4 +- docs/users/listFollowedByAuthenticatedUser.md | 4 +- .../listFollowersForAuthenticatedUser.md | 4 +- docs/users/listFollowersForUser.md | 4 +- docs/users/listFollowingForUser.md | 4 +- docs/users/listGpgKeysForAuthenticated.md | 8 +- docs/users/listGpgKeysForAuthenticatedUser.md | 8 +- docs/users/listGpgKeysForUser.md | 4 +- .../users/listPublicEmailsForAuthenticated.md | 10 +- .../listPublicEmailsForAuthenticatedUser.md | 10 +- docs/users/listPublicKeysForUser.md | 4 +- .../listPublicSshKeysForAuthenticated.md | 8 +- .../listPublicSshKeysForAuthenticatedUser.md | 8 +- .../listSocialAccountsForAuthenticatedUser.md | 4 +- docs/users/listSocialAccountsForUser.md | 4 +- .../listSshSigningKeysForAuthenticatedUser.md | 8 +- docs/users/listSshSigningKeysForUser.md | 4 +- docs/users/unfollow.md | 2 +- .../update-endpoints/generated/endpoints.json | 4083 ++++++++++++----- src/generated/endpoints.ts | 51 +- src/generated/method-types.ts | 2758 +++++++---- .../parameters-and-response-types.ts | 103 +- 613 files changed, 8029 insertions(+), 3667 deletions(-) create mode 100644 docs/activity/markThreadAsDone.md create mode 100644 docs/copilot/addCopilotSeatsForTeams.md create mode 100644 docs/copilot/addCopilotSeatsForUsers.md create mode 100644 docs/orgs/assignTeamToOrgRole.md create mode 100644 docs/orgs/assignUserToOrgRole.md create mode 100644 docs/orgs/createCustomOrganizationRole.md create mode 100644 docs/orgs/deleteCustomOrganizationRole.md create mode 100644 docs/orgs/getOrgRole.md create mode 100644 docs/orgs/listOrgRoleTeams.md create mode 100644 docs/orgs/listOrgRoleUsers.md create mode 100644 docs/orgs/listOrgRoles.md create mode 100644 docs/orgs/listOrganizationFineGrainedPermissions.md create mode 100644 docs/orgs/patchCustomOrganizationRole.md create mode 100644 docs/orgs/revokeAllOrgRolesTeam.md create mode 100644 docs/orgs/revokeAllOrgRolesUser.md create mode 100644 docs/orgs/revokeOrgRoleTeam.md create mode 100644 docs/orgs/revokeOrgRoleUser.md create mode 100644 docs/repos/cancelPagesDeployment.md create mode 100644 docs/repos/createOrUpdateCustomPropertiesValues.md create mode 100644 docs/repos/getPagesDeployment.md create mode 100644 docs/securityAdvisories/createFork.md diff --git a/docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md b/docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md index 2e43cb5fe..d6140a61a 100644 --- a/docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md +++ b/docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md @@ -8,12 +8,11 @@ type: API method # Add custom labels to a self-hosted runner for an organization -Add custom labels to a self-hosted runner configured in an organization. +Adds custom labels to a self-hosted runner configured in an organization. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the organization to use this endpoint. + +OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForOrg({ diff --git a/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md b/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md index e147b2ebb..759699919 100644 --- a/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md +++ b/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md @@ -8,11 +8,11 @@ type: API method # Add custom labels to a self-hosted runner for a repository -Add custom labels to a self-hosted runner configured in a repository. +Adds custom labels to a self-hosted runner configured in a repository. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the organization to use this endpoint. + +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForRepo({ diff --git a/docs/actions/addSelectedRepoToOrgSecret.md b/docs/actions/addSelectedRepoToOrgSecret.md index 1499e860d..a8cd25cd1 100644 --- a/docs/actions/addSelectedRepoToOrgSecret.md +++ b/docs/actions/addSelectedRepoToOrgSecret.md @@ -9,14 +9,13 @@ type: API method # Add selected repository to an organization secret Adds a repository to an organization secret when the `visibility` for -repository access is set to `selected`. The visibility is set when you [Create or +repository access is set to `selected`. For more information about setting the visibility, see [Create or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.addSelectedRepoToOrgSecret({ org, diff --git a/docs/actions/addSelectedRepoToOrgVariable.md b/docs/actions/addSelectedRepoToOrgVariable.md index ad8cf28a4..9123e19b2 100644 --- a/docs/actions/addSelectedRepoToOrgVariable.md +++ b/docs/actions/addSelectedRepoToOrgVariable.md @@ -11,10 +11,9 @@ type: API method Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. -Authenticated users must have collaborator access to a repository to create, update, or read variables. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. + +OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.addSelectedRepoToOrgVariable({ diff --git a/docs/actions/approveWorkflowRun.md b/docs/actions/approveWorkflowRun.md index 4db622255..ed8ccb9fd 100644 --- a/docs/actions/approveWorkflowRun.md +++ b/docs/actions/approveWorkflowRun.md @@ -10,7 +10,7 @@ type: API method Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." -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 tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.approveWorkflowRun({ diff --git a/docs/actions/cancelWorkflowRun.md b/docs/actions/cancelWorkflowRun.md index aa70c1030..55331aabc 100644 --- a/docs/actions/cancelWorkflowRun.md +++ b/docs/actions/cancelWorkflowRun.md @@ -10,8 +10,7 @@ type: API method Cancels a workflow run using its `id`. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `actions:write` permission to use this endpoint. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.cancelWorkflowRun({ diff --git a/docs/actions/createEnvironmentVariable.md b/docs/actions/createEnvironmentVariable.md index 3b1521973..b37054d41 100644 --- a/docs/actions/createEnvironmentVariable.md +++ b/docs/actions/createEnvironmentVariable.md @@ -10,10 +10,10 @@ type: API method Create an environment variable that you can reference in a GitHub Actions workflow. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `environment:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.createEnvironmentVariable({ repository_id, @@ -41,7 +41,7 @@ The unique identifier of the repository. environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. nameyes diff --git a/docs/actions/createOrUpdateEnvironmentSecret.md b/docs/actions/createOrUpdateEnvironmentSecret.md index b4785a0f4..aa89118e2 100644 --- a/docs/actions/createOrUpdateEnvironmentSecret.md +++ b/docs/actions/createOrUpdateEnvironmentSecret.md @@ -11,10 +11,10 @@ type: API method Creates or updates an environment secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.createOrUpdateEnvironmentSecret({ repository_id, @@ -43,7 +43,7 @@ The unique identifier of the repository. environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. secret_nameyes diff --git a/docs/actions/createOrUpdateRepoSecret.md b/docs/actions/createOrUpdateRepoSecret.md index 6eb975a8c..9c6e45ca3 100644 --- a/docs/actions/createOrUpdateRepoSecret.md +++ b/docs/actions/createOrUpdateRepoSecret.md @@ -11,10 +11,10 @@ type: API method Creates or updates a repository secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.createOrUpdateRepoSecret({ owner, diff --git a/docs/actions/createOrgVariable.md b/docs/actions/createOrgVariable.md index 1273d70a8..ccabb4816 100644 --- a/docs/actions/createOrgVariable.md +++ b/docs/actions/createOrgVariable.md @@ -10,11 +10,10 @@ type: API method Creates an organization variable that you can reference in a GitHub Actions workflow. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.createOrgVariable({ org, diff --git a/docs/actions/createRegistrationTokenForOrg.md b/docs/actions/createRegistrationTokenForOrg.md index 788936c26..0ea3c1403 100644 --- a/docs/actions/createRegistrationTokenForOrg.md +++ b/docs/actions/createRegistrationTokenForOrg.md @@ -10,19 +10,16 @@ type: API method Returns a token that you can pass to the `config` script. The token expires after one hour. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - -Example using registration token: - -Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. +For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: ``` ./config.sh --url https://github.com/octo-org --token TOKEN ``` +Authenticated users must have admin access to the organization to use this endpoint. + +OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.createRegistrationTokenForOrg({ org, diff --git a/docs/actions/createRegistrationTokenForRepo.md b/docs/actions/createRegistrationTokenForRepo.md index 35c6b82ad..8c6e0e1d6 100644 --- a/docs/actions/createRegistrationTokenForRepo.md +++ b/docs/actions/createRegistrationTokenForRepo.md @@ -8,19 +8,17 @@ type: API method # Create a registration token for a repository -Returns a token that you can pass to the `config` script. The token -expires after one hour. +Returns a token that you can pass to the `config` script. The token expires after one hour. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: -Example using registration token: +``` +./config.sh --url https://github.com/octo-org --token TOKEN +``` -Configure your self-hosted runner, replacing `TOKEN` with the registration token provided -by this endpoint. +Authenticated users must have admin access to the repository to use this endpoint. -`config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN` +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.createRegistrationTokenForRepo({ diff --git a/docs/actions/createRemoveTokenForOrg.md b/docs/actions/createRemoveTokenForOrg.md index 276dc1e7f..6194500be 100644 --- a/docs/actions/createRemoveTokenForOrg.md +++ b/docs/actions/createRemoveTokenForOrg.md @@ -10,20 +10,16 @@ type: API method Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - -Example using remove token: - -To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this -endpoint. +For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: ``` ./config.sh remove --token TOKEN ``` +Authenticated users must have admin access to the organization to use this endpoint. + +OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.createRemoveTokenForOrg({ org, diff --git a/docs/actions/createRemoveTokenForRepo.md b/docs/actions/createRemoveTokenForRepo.md index ee66f55d9..ee3212a65 100644 --- a/docs/actions/createRemoveTokenForRepo.md +++ b/docs/actions/createRemoveTokenForRepo.md @@ -8,19 +8,17 @@ type: API method # Create a remove token for a repository -Returns a token that you can pass to remove a self-hosted runner from -a repository. The token expires after one hour. +Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: -Example using remove token: +``` +./config.sh remove --token TOKEN +``` -To remove your self-hosted runner from a repository, replace TOKEN with -the remove token provided by this endpoint. +Authenticated users must have admin access to the repository to use this endpoint. -`config.sh remove --token TOKEN` +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.createRemoveTokenForRepo({ diff --git a/docs/actions/createRepoVariable.md b/docs/actions/createRepoVariable.md index 36277f0e3..49efcc169 100644 --- a/docs/actions/createRepoVariable.md +++ b/docs/actions/createRepoVariable.md @@ -10,10 +10,10 @@ type: API method Creates a repository variable that you can reference in a GitHub Actions workflow. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.createRepoVariable({ owner, diff --git a/docs/actions/createWorkflowDispatch.md b/docs/actions/createWorkflowDispatch.md index 9a579a042..816b8d6d3 100644 --- a/docs/actions/createWorkflowDispatch.md +++ b/docs/actions/createWorkflowDispatch.md @@ -12,7 +12,7 @@ You can use this endpoint to manually trigger a GitHub Actions workflow run. You You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.createWorkflowDispatch({ diff --git a/docs/actions/deleteActionsCacheById.md b/docs/actions/deleteActionsCacheById.md index 22389b98d..37ffa78c7 100644 --- a/docs/actions/deleteActionsCacheById.md +++ b/docs/actions/deleteActionsCacheById.md @@ -10,9 +10,7 @@ type: API method Deletes a GitHub Actions cache for a repository, using a cache ID. -You must authenticate using an access token with the `repo` scope to use this endpoint. - -GitHub Apps must have the `actions:write` permission to use this endpoint. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.deleteActionsCacheById({ diff --git a/docs/actions/deleteActionsCacheByKey.md b/docs/actions/deleteActionsCacheByKey.md index 0fa05d299..7751f3794 100644 --- a/docs/actions/deleteActionsCacheByKey.md +++ b/docs/actions/deleteActionsCacheByKey.md @@ -10,9 +10,7 @@ type: API method Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. -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 tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.deleteActionsCacheByKey({ diff --git a/docs/actions/deleteArtifact.md b/docs/actions/deleteArtifact.md index 444d083b2..1a2a56c9d 100644 --- a/docs/actions/deleteArtifact.md +++ b/docs/actions/deleteArtifact.md @@ -8,7 +8,8 @@ type: API method # Delete an artifact -Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. +Deletes an artifact for a workflow run. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.deleteArtifact({ diff --git a/docs/actions/deleteEnvironmentSecret.md b/docs/actions/deleteEnvironmentSecret.md index 906cde809..4e7d40989 100644 --- a/docs/actions/deleteEnvironmentSecret.md +++ b/docs/actions/deleteEnvironmentSecret.md @@ -10,10 +10,10 @@ type: API method Deletes a secret in an environment using the secret name. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.deleteEnvironmentSecret({ repository_id, @@ -40,7 +40,7 @@ The unique identifier of the repository. environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. secret_nameyes diff --git a/docs/actions/deleteEnvironmentVariable.md b/docs/actions/deleteEnvironmentVariable.md index 6f7e3a0dc..118d2e499 100644 --- a/docs/actions/deleteEnvironmentVariable.md +++ b/docs/actions/deleteEnvironmentVariable.md @@ -10,10 +10,10 @@ type: API method Deletes an environment variable using the variable name. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `environment:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.deleteEnvironmentVariable({ repository_id, @@ -45,7 +45,7 @@ The name of the variable. environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. diff --git a/docs/actions/deleteOrgSecret.md b/docs/actions/deleteOrgSecret.md index 0d6711e3b..75b3721aa 100644 --- a/docs/actions/deleteOrgSecret.md +++ b/docs/actions/deleteOrgSecret.md @@ -10,11 +10,10 @@ type: API method Deletes a secret in an organization using the secret name. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.deleteOrgSecret({ org, diff --git a/docs/actions/deleteOrgVariable.md b/docs/actions/deleteOrgVariable.md index 67907a535..e86a24298 100644 --- a/docs/actions/deleteOrgVariable.md +++ b/docs/actions/deleteOrgVariable.md @@ -10,11 +10,10 @@ type: API method Deletes an organization variable using the variable name. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.deleteOrgVariable({ org, diff --git a/docs/actions/deleteRepoSecret.md b/docs/actions/deleteRepoSecret.md index 43720b542..56279d80c 100644 --- a/docs/actions/deleteRepoSecret.md +++ b/docs/actions/deleteRepoSecret.md @@ -10,10 +10,10 @@ type: API method Deletes a secret in a repository using the secret name. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.deleteRepoSecret({ owner, diff --git a/docs/actions/deleteRepoVariable.md b/docs/actions/deleteRepoVariable.md index 7d8369227..9548ae161 100644 --- a/docs/actions/deleteRepoVariable.md +++ b/docs/actions/deleteRepoVariable.md @@ -10,10 +10,10 @@ type: API method Deletes a repository variable using the variable name. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.deleteRepoVariable({ owner, diff --git a/docs/actions/deleteSelfHostedRunnerFromOrg.md b/docs/actions/deleteSelfHostedRunnerFromOrg.md index 4e1b4caeb..71d746f61 100644 --- a/docs/actions/deleteSelfHostedRunnerFromOrg.md +++ b/docs/actions/deleteSelfHostedRunnerFromOrg.md @@ -10,10 +10,9 @@ type: API method Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the organization to use this endpoint. + +OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.deleteSelfHostedRunnerFromOrg({ diff --git a/docs/actions/deleteSelfHostedRunnerFromRepo.md b/docs/actions/deleteSelfHostedRunnerFromRepo.md index eca9d3dfa..bb5edb5df 100644 --- a/docs/actions/deleteSelfHostedRunnerFromRepo.md +++ b/docs/actions/deleteSelfHostedRunnerFromRepo.md @@ -10,9 +10,9 @@ type: API method Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the repository to use this endpoint. + +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.deleteSelfHostedRunnerFromRepo({ diff --git a/docs/actions/deleteWorkflowRun.md b/docs/actions/deleteWorkflowRun.md index 7f7b24d48..65a5953e1 100644 --- a/docs/actions/deleteWorkflowRun.md +++ b/docs/actions/deleteWorkflowRun.md @@ -8,9 +8,11 @@ type: API method # Delete a workflow run -Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is -private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use -this endpoint. +Deletes a specific workflow run. + +Anyone with write access to the repository can use this endpoint. + +If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.deleteWorkflowRun({ diff --git a/docs/actions/deleteWorkflowRunLogs.md b/docs/actions/deleteWorkflowRunLogs.md index 9bdd3b45a..d595b4188 100644 --- a/docs/actions/deleteWorkflowRunLogs.md +++ b/docs/actions/deleteWorkflowRunLogs.md @@ -8,7 +8,9 @@ type: API method # Delete workflow run logs -Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. +Deletes all logs for a workflow run. + +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.deleteWorkflowRunLogs({ diff --git a/docs/actions/disableSelectedRepositoryGithubActionsOrganization.md b/docs/actions/disableSelectedRepositoryGithubActionsOrganization.md index 4b7529252..20f2e6ceb 100644 --- a/docs/actions/disableSelectedRepositoryGithubActionsOrganization.md +++ b/docs/actions/disableSelectedRepositoryGithubActionsOrganization.md @@ -10,7 +10,7 @@ type: API method Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." -You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. +OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.actions.disableSelectedRepositoryGithubActionsOrganization({ diff --git a/docs/actions/disableWorkflow.md b/docs/actions/disableWorkflow.md index 7c112b8c6..2a0e7b391 100644 --- a/docs/actions/disableWorkflow.md +++ b/docs/actions/disableWorkflow.md @@ -10,7 +10,7 @@ type: API method Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. -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 tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.disableWorkflow({ diff --git a/docs/actions/downloadArtifact.md b/docs/actions/downloadArtifact.md index 9a0243621..a873dff39 100644 --- a/docs/actions/downloadArtifact.md +++ b/docs/actions/downloadArtifact.md @@ -11,8 +11,7 @@ type: API method Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. The `:archive_format` must be `zip`. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `actions: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.downloadArtifact({ diff --git a/docs/actions/downloadJobLogsForWorkflowRun.md b/docs/actions/downloadJobLogsForWorkflowRun.md index 4231a2f78..5eb84f307 100644 --- a/docs/actions/downloadJobLogsForWorkflowRun.md +++ b/docs/actions/downloadJobLogsForWorkflowRun.md @@ -9,9 +9,11 @@ type: API method # Download job logs for a workflow run Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look -for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can -use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must -have the `actions:read` permission to use this endpoint. +for `Location:` in the response header to find the URL for the download. + +Anyone with read access to the repository can use this endpoint. + +If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.downloadJobLogsForWorkflowRun({ diff --git a/docs/actions/downloadWorkflowRunAttemptLogs.md b/docs/actions/downloadWorkflowRunAttemptLogs.md index 8b622e14b..a9883acfa 100644 --- a/docs/actions/downloadWorkflowRunAttemptLogs.md +++ b/docs/actions/downloadWorkflowRunAttemptLogs.md @@ -9,9 +9,11 @@ type: API method # Download workflow run attempt logs Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after -1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to -the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. -GitHub Apps must have the `actions:read` permission to use this endpoint. +1 minute. Look for `Location:` in the response header to find the URL for the download. + +Anyone with read access to the repository can use this endpoint. + +If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.downloadWorkflowRunAttemptLogs({ diff --git a/docs/actions/downloadWorkflowRunLogs.md b/docs/actions/downloadWorkflowRunLogs.md index 638500567..f5a443968 100644 --- a/docs/actions/downloadWorkflowRunLogs.md +++ b/docs/actions/downloadWorkflowRunLogs.md @@ -9,9 +9,11 @@ type: API method # Download workflow run logs Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for -`Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use -this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have -the `actions:read` permission to use this endpoint. +`Location:` in the response header to find the URL for the download. + +Anyone with read access to the repository can use this endpoint. + +If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.downloadWorkflowRunLogs({ diff --git a/docs/actions/enableSelectedRepositoryGithubActionsOrganization.md b/docs/actions/enableSelectedRepositoryGithubActionsOrganization.md index d32e6da6b..761709f94 100644 --- a/docs/actions/enableSelectedRepositoryGithubActionsOrganization.md +++ b/docs/actions/enableSelectedRepositoryGithubActionsOrganization.md @@ -10,7 +10,7 @@ type: API method Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." -You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. +OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.actions.enableSelectedRepositoryGithubActionsOrganization({ diff --git a/docs/actions/enableWorkflow.md b/docs/actions/enableWorkflow.md index eaac37397..8db48627e 100644 --- a/docs/actions/enableWorkflow.md +++ b/docs/actions/enableWorkflow.md @@ -10,7 +10,7 @@ type: API method Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. -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 tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.enableWorkflow({ diff --git a/docs/actions/forceCancelWorkflowRun.md b/docs/actions/forceCancelWorkflowRun.md index 5d3647924..90a3a82e1 100644 --- a/docs/actions/forceCancelWorkflowRun.md +++ b/docs/actions/forceCancelWorkflowRun.md @@ -11,8 +11,7 @@ type: API method Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `actions:write` permission to use this endpoint. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.forceCancelWorkflowRun({ diff --git a/docs/actions/generateRunnerJitconfigForOrg.md b/docs/actions/generateRunnerJitconfigForOrg.md index 0fd978aca..1a67cc97a 100644 --- a/docs/actions/generateRunnerJitconfigForOrg.md +++ b/docs/actions/generateRunnerJitconfigForOrg.md @@ -10,10 +10,9 @@ type: API method Generates a configuration that can be passed to the runner application at startup. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +The authenticated user must have admin access to the organization. + +OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.generateRunnerJitconfigForOrg({ diff --git a/docs/actions/generateRunnerJitconfigForRepo.md b/docs/actions/generateRunnerJitconfigForRepo.md index 43a2d9874..1050310f9 100644 --- a/docs/actions/generateRunnerJitconfigForRepo.md +++ b/docs/actions/generateRunnerJitconfigForRepo.md @@ -10,9 +10,9 @@ type: API method Generates a configuration that can be passed to the runner application at startup. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +The authenticated user must have admin access to the repository. + +OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. ```js octokit.rest.actions.generateRunnerJitconfigForRepo({ diff --git a/docs/actions/getActionsCacheList.md b/docs/actions/getActionsCacheList.md index 598c5c8f0..c70a0f516 100644 --- a/docs/actions/getActionsCacheList.md +++ b/docs/actions/getActionsCacheList.md @@ -9,8 +9,8 @@ type: API method # List GitHub Actions caches for a repository Lists the GitHub Actions caches for a repository. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `actions: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.getActionsCacheList({ @@ -42,12 +42,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." refno diff --git a/docs/actions/getActionsCacheUsage.md b/docs/actions/getActionsCacheUsage.md index 5a40969de..4beb6b005 100644 --- a/docs/actions/getActionsCacheUsage.md +++ b/docs/actions/getActionsCacheUsage.md @@ -10,7 +10,10 @@ type: API method Gets GitHub Actions cache usage for a repository. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. -Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + +Anyone with read access to the repository can use this endpoint. + +If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getActionsCacheUsage({ diff --git a/docs/actions/getActionsCacheUsageByRepoForOrg.md b/docs/actions/getActionsCacheUsageByRepoForOrg.md index 665e99e6f..af4c8b51c 100644 --- a/docs/actions/getActionsCacheUsageByRepoForOrg.md +++ b/docs/actions/getActionsCacheUsageByRepoForOrg.md @@ -10,7 +10,8 @@ type: API method Lists repositories and their GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. -You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + +OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. ```js octokit.rest.actions.getActionsCacheUsageByRepoForOrg({ @@ -36,12 +37,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/getActionsCacheUsageForOrg.md b/docs/actions/getActionsCacheUsageForOrg.md index 8a41ad6c8..cd6350dd2 100644 --- a/docs/actions/getActionsCacheUsageForOrg.md +++ b/docs/actions/getActionsCacheUsageForOrg.md @@ -10,7 +10,8 @@ type: API method Gets the total GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. -You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + +OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. ```js octokit.rest.actions.getActionsCacheUsageForOrg({ diff --git a/docs/actions/getAllowedActionsOrganization.md b/docs/actions/getAllowedActionsOrganization.md index db960d6a8..2d4508a82 100644 --- a/docs/actions/getAllowedActionsOrganization.md +++ b/docs/actions/getAllowedActionsOrganization.md @@ -8,9 +8,9 @@ type: API method # Get allowed actions and reusable workflows for an organization -Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" +Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." -You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. +OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.actions.getAllowedActionsOrganization({ diff --git a/docs/actions/getAllowedActionsRepository.md b/docs/actions/getAllowedActionsRepository.md index fed8545e9..4d80a909b 100644 --- a/docs/actions/getAllowedActionsRepository.md +++ b/docs/actions/getAllowedActionsRepository.md @@ -10,7 +10,7 @@ type: API method Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getAllowedActionsRepository({ diff --git a/docs/actions/getArtifact.md b/docs/actions/getArtifact.md index 9651d4d19..364135877 100644 --- a/docs/actions/getArtifact.md +++ b/docs/actions/getArtifact.md @@ -8,7 +8,11 @@ type: API method # Get an artifact -Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +Gets a specific artifact for a workflow run. + +Anyone with read access to the repository can use this endpoint. + +If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getArtifact({ diff --git a/docs/actions/getEnvironmentPublicKey.md b/docs/actions/getEnvironmentPublicKey.md index ce62624ed..72222bd91 100644 --- a/docs/actions/getEnvironmentPublicKey.md +++ b/docs/actions/getEnvironmentPublicKey.md @@ -12,9 +12,8 @@ Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. -If the repository is private you must use an access token with the `repo` scope. -GitHub Apps must have the `secrets` repository permission to use this endpoint. -Authenticated users must have collaborator access to a repository to create, update, or read secrets. + +If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getEnvironmentPublicKey({ @@ -41,7 +40,7 @@ The unique identifier of the repository. environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. diff --git a/docs/actions/getEnvironmentSecret.md b/docs/actions/getEnvironmentSecret.md index e33351474..ba5fc2cf9 100644 --- a/docs/actions/getEnvironmentSecret.md +++ b/docs/actions/getEnvironmentSecret.md @@ -10,10 +10,10 @@ type: API method Gets a single environment secret without revealing its encrypted value. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.getEnvironmentSecret({ repository_id, @@ -40,7 +40,7 @@ The unique identifier of the repository. environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. secret_nameyes diff --git a/docs/actions/getEnvironmentVariable.md b/docs/actions/getEnvironmentVariable.md index f82d83796..d79c2e439 100644 --- a/docs/actions/getEnvironmentVariable.md +++ b/docs/actions/getEnvironmentVariable.md @@ -10,10 +10,10 @@ type: API method Gets a specific variable in an environment. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `environments:read` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.getEnvironmentVariable({ repository_id, @@ -40,7 +40,7 @@ The unique identifier of the repository. environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. nameyes diff --git a/docs/actions/getGithubActionsDefaultWorkflowPermissionsOrganization.md b/docs/actions/getGithubActionsDefaultWorkflowPermissionsOrganization.md index 7e747ad07..0f0cee189 100644 --- a/docs/actions/getGithubActionsDefaultWorkflowPermissionsOrganization.md +++ b/docs/actions/getGithubActionsDefaultWorkflowPermissionsOrganization.md @@ -12,7 +12,7 @@ Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running as well as whether GitHub Actions can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." -You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. +OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.actions.getGithubActionsDefaultWorkflowPermissionsOrganization({ diff --git a/docs/actions/getGithubActionsDefaultWorkflowPermissionsRepository.md b/docs/actions/getGithubActionsDefaultWorkflowPermissionsRepository.md index 7f032e3b9..4715523d2 100644 --- a/docs/actions/getGithubActionsDefaultWorkflowPermissionsRepository.md +++ b/docs/actions/getGithubActionsDefaultWorkflowPermissionsRepository.md @@ -12,7 +12,7 @@ Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running as well as if GitHub Actions can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getGithubActionsDefaultWorkflowPermissionsRepository({ diff --git a/docs/actions/getGithubActionsPermissionsOrganization.md b/docs/actions/getGithubActionsPermissionsOrganization.md index cd0b95737..b7af05b8e 100644 --- a/docs/actions/getGithubActionsPermissionsOrganization.md +++ b/docs/actions/getGithubActionsPermissionsOrganization.md @@ -10,7 +10,7 @@ type: API method Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. +OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.actions.getGithubActionsPermissionsOrganization({ diff --git a/docs/actions/getGithubActionsPermissionsRepository.md b/docs/actions/getGithubActionsPermissionsRepository.md index 33f1a04d8..6ba4cda09 100644 --- a/docs/actions/getGithubActionsPermissionsRepository.md +++ b/docs/actions/getGithubActionsPermissionsRepository.md @@ -10,7 +10,7 @@ type: API method Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getGithubActionsPermissionsRepository({ diff --git a/docs/actions/getJobForWorkflowRun.md b/docs/actions/getJobForWorkflowRun.md index c63e93c8b..6c0c2829e 100644 --- a/docs/actions/getJobForWorkflowRun.md +++ b/docs/actions/getJobForWorkflowRun.md @@ -8,7 +8,11 @@ type: API method # Get a job for a workflow run -Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +Gets a specific job in a workflow run. + +Anyone with read access to the repository can use this endpoint. + +If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getJobForWorkflowRun({ diff --git a/docs/actions/getOrgPublicKey.md b/docs/actions/getOrgPublicKey.md index ff6a63d4a..8bf18706b 100644 --- a/docs/actions/getOrgPublicKey.md +++ b/docs/actions/getOrgPublicKey.md @@ -11,10 +11,9 @@ type: API method Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `secrets` organization permission to use this endpoint. -Authenticated users must have collaborator access to a repository to create, update, or read secrets. +The authenticated user must have collaborator access to a repository to create, update, or read secrets. + +OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getOrgPublicKey({ diff --git a/docs/actions/getOrgSecret.md b/docs/actions/getOrgSecret.md index 02c161737..179dc6e9c 100644 --- a/docs/actions/getOrgSecret.md +++ b/docs/actions/getOrgSecret.md @@ -10,10 +10,9 @@ type: API method Gets a single organization secret without revealing its encrypted value. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `secrets` organization permission to use this endpoint. -Authenticated users must have collaborator access to a repository to create, update, or read secrets. +The authenticated user must have collaborator access to a repository to create, update, or read secrets + +OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getOrgSecret({ diff --git a/docs/actions/getOrgVariable.md b/docs/actions/getOrgVariable.md index 3374e4b70..dbe38f251 100644 --- a/docs/actions/getOrgVariable.md +++ b/docs/actions/getOrgVariable.md @@ -10,10 +10,9 @@ type: API method Gets a specific variable in an organization. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. -Authenticated users must have collaborator access to a repository to create, update, or read variables. +The authenticated user must have collaborator access to a repository to create, update, or read variables. + +OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getOrgVariable({ diff --git a/docs/actions/getPendingDeploymentsForRun.md b/docs/actions/getPendingDeploymentsForRun.md index 068211bf5..c128406c0 100644 --- a/docs/actions/getPendingDeploymentsForRun.md +++ b/docs/actions/getPendingDeploymentsForRun.md @@ -10,7 +10,9 @@ type: API method Get all deployment environments for a workflow run that are waiting for protection rules to pass. -Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +Anyone with read access to the repository can use this endpoint. + +If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getPendingDeploymentsForRun({ diff --git a/docs/actions/getRepoPermissions.md b/docs/actions/getRepoPermissions.md index 9accd653f..c8b0330e4 100644 --- a/docs/actions/getRepoPermissions.md +++ b/docs/actions/getRepoPermissions.md @@ -12,7 +12,7 @@ type: API method Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getRepoPermissions({ diff --git a/docs/actions/getRepoPublicKey.md b/docs/actions/getRepoPublicKey.md index 3aed36d1b..3a00cbbf5 100644 --- a/docs/actions/getRepoPublicKey.md +++ b/docs/actions/getRepoPublicKey.md @@ -12,9 +12,8 @@ Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. -If the repository is private you must use an access token with the `repo` scope. -GitHub Apps must have the `secrets` repository permission to use this endpoint. -Authenticated users must have collaborator access to a repository to create, update, or read secrets. + +If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getRepoPublicKey({ diff --git a/docs/actions/getRepoSecret.md b/docs/actions/getRepoSecret.md index 50125f83b..27cc5e9fe 100644 --- a/docs/actions/getRepoSecret.md +++ b/docs/actions/getRepoSecret.md @@ -10,9 +10,9 @@ type: API method Gets a single repository secret without revealing its encrypted value. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `secrets` repository permission to use this endpoint. -Authenticated users must have collaborator access to a repository to create, update, or read secrets. +The authenticated user must have collaborator access to the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getRepoSecret({ diff --git a/docs/actions/getRepoVariable.md b/docs/actions/getRepoVariable.md index b729b89c9..f38062ffd 100644 --- a/docs/actions/getRepoVariable.md +++ b/docs/actions/getRepoVariable.md @@ -10,9 +10,9 @@ type: API method Gets a specific variable in a repository. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. -Authenticated users must have collaborator access to a repository to create, update, or read variables. +The authenticated user must have collaborator access to the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getRepoVariable({ diff --git a/docs/actions/getReviewsForRun.md b/docs/actions/getReviewsForRun.md index 9c1848f99..615e1eaf1 100644 --- a/docs/actions/getReviewsForRun.md +++ b/docs/actions/getReviewsForRun.md @@ -8,7 +8,9 @@ type: API method # Get the review history for a workflow run -Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +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. ```js octokit.rest.actions.getReviewsForRun({ diff --git a/docs/actions/getSelfHostedRunnerForOrg.md b/docs/actions/getSelfHostedRunnerForOrg.md index c34445776..2bc85c97d 100644 --- a/docs/actions/getSelfHostedRunnerForOrg.md +++ b/docs/actions/getSelfHostedRunnerForOrg.md @@ -10,10 +10,9 @@ type: API method Gets a specific self-hosted runner configured in an organization. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. ```js octokit.rest.actions.getSelfHostedRunnerForOrg({ diff --git a/docs/actions/getSelfHostedRunnerForRepo.md b/docs/actions/getSelfHostedRunnerForRepo.md index 1c732c53a..8771ddca5 100644 --- a/docs/actions/getSelfHostedRunnerForRepo.md +++ b/docs/actions/getSelfHostedRunnerForRepo.md @@ -10,9 +10,9 @@ type: API method Gets a specific self-hosted runner configured in a repository. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getSelfHostedRunnerForRepo({ diff --git a/docs/actions/getWorkflow.md b/docs/actions/getWorkflow.md index effbcc1bd..b78b59cbf 100644 --- a/docs/actions/getWorkflow.md +++ b/docs/actions/getWorkflow.md @@ -8,7 +8,12 @@ type: API method # Get a workflow -Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +Gets a specific workflow. You can replace `workflow_id` with the workflow +file name. For example, you could use `main.yaml`. + +Anyone with read access to the repository can use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. ```js octokit.rest.actions.getWorkflow({ diff --git a/docs/actions/getWorkflowAccessToRepository.md b/docs/actions/getWorkflowAccessToRepository.md index 104452c52..e92e39bed 100644 --- a/docs/actions/getWorkflowAccessToRepository.md +++ b/docs/actions/getWorkflowAccessToRepository.md @@ -12,8 +12,7 @@ Gets the level of access that workflows outside of the repository have to action This endpoint only applies to private repositories. For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the -repository `administration` permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getWorkflowAccessToRepository({ diff --git a/docs/actions/getWorkflowRun.md b/docs/actions/getWorkflowRun.md index 117871f92..a4d1f1f66 100644 --- a/docs/actions/getWorkflowRun.md +++ b/docs/actions/getWorkflowRun.md @@ -8,7 +8,11 @@ type: API method # Get a workflow run -Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +Gets a specific workflow run. + +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. ```js octokit.rest.actions.getWorkflowRun({ diff --git a/docs/actions/getWorkflowRunAttempt.md b/docs/actions/getWorkflowRunAttempt.md index cc35b1bed..c5a5c1810 100644 --- a/docs/actions/getWorkflowRunAttempt.md +++ b/docs/actions/getWorkflowRunAttempt.md @@ -8,10 +8,11 @@ type: API method # Get a workflow run attempt -Gets a specific workflow run attempt. Anyone with read access to the repository -can use this endpoint. If the repository is private you must use an access token -with the `repo` scope. GitHub Apps must have the `actions:read` permission to -use this endpoint. +Gets a specific workflow run attempt. + +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. ```js octokit.rest.actions.getWorkflowRunAttempt({ diff --git a/docs/actions/getWorkflowRunUsage.md b/docs/actions/getWorkflowRunUsage.md index 11e10603c..5618184d7 100644 --- a/docs/actions/getWorkflowRunUsage.md +++ b/docs/actions/getWorkflowRunUsage.md @@ -10,7 +10,9 @@ type: API method Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". -Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +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. ```js octokit.rest.actions.getWorkflowRunUsage({ diff --git a/docs/actions/getWorkflowUsage.md b/docs/actions/getWorkflowUsage.md index b56ff7675..e8473da30 100644 --- a/docs/actions/getWorkflowUsage.md +++ b/docs/actions/getWorkflowUsage.md @@ -10,7 +10,11 @@ type: API method Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". -You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + +Anyone with read access to the repository can use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. ```js octokit.rest.actions.getWorkflowUsage({ diff --git a/docs/actions/listArtifactsForRepo.md b/docs/actions/listArtifactsForRepo.md index 467a590f6..5bbc9dd02 100644 --- a/docs/actions/listArtifactsForRepo.md +++ b/docs/actions/listArtifactsForRepo.md @@ -8,7 +8,11 @@ type: API method # List artifacts for a repository -Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +Lists all artifacts for a repository. + +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. ```js octokit.rest.actions.listArtifactsForRepo({ @@ -40,12 +44,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." nameno diff --git a/docs/actions/listEnvironmentSecrets.md b/docs/actions/listEnvironmentSecrets.md index 20506c47c..a02fc00a3 100644 --- a/docs/actions/listEnvironmentSecrets.md +++ b/docs/actions/listEnvironmentSecrets.md @@ -11,10 +11,10 @@ type: API method Lists all secrets available in an environment without revealing their encrypted values. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.listEnvironmentSecrets({ repository_id, @@ -40,17 +40,17 @@ The unique identifier of the repository. environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listEnvironmentVariables.md b/docs/actions/listEnvironmentVariables.md index 07633ec4f..c68c39c4f 100644 --- a/docs/actions/listEnvironmentVariables.md +++ b/docs/actions/listEnvironmentVariables.md @@ -10,10 +10,10 @@ type: API method Lists all environment variables. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `environments:read` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.listEnvironmentVariables({ repository_id, @@ -39,17 +39,17 @@ The unique identifier of the repository. environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. per_pageno -The number of results per page (max 30). +The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listJobsForWorkflowRun.md b/docs/actions/listJobsForWorkflowRun.md index 0df853572..74aae8216 100644 --- a/docs/actions/listJobsForWorkflowRun.md +++ b/docs/actions/listJobsForWorkflowRun.md @@ -8,7 +8,12 @@ type: API method # List jobs for a workflow run -Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). +Lists jobs for a workflow run. 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). + +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. ```js octokit.rest.actions.listJobsForWorkflowRun({ @@ -51,12 +56,12 @@ Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the m per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listJobsForWorkflowRunAttempt.md b/docs/actions/listJobsForWorkflowRunAttempt.md index d111bc9da..4e7139999 100644 --- a/docs/actions/listJobsForWorkflowRunAttempt.md +++ b/docs/actions/listJobsForWorkflowRunAttempt.md @@ -8,7 +8,12 @@ type: API method # List jobs for a workflow run attempt -Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). +Lists jobs for a specific workflow run attempt. 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). + +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. ```js octokit.rest.actions.listJobsForWorkflowRunAttempt({ @@ -52,12 +57,12 @@ The attempt number of the workflow run. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listLabelsForSelfHostedRunnerForOrg.md b/docs/actions/listLabelsForSelfHostedRunnerForOrg.md index d0b5b0f56..9d5b85227 100644 --- a/docs/actions/listLabelsForSelfHostedRunnerForOrg.md +++ b/docs/actions/listLabelsForSelfHostedRunnerForOrg.md @@ -10,10 +10,9 @@ type: API method Lists all labels for a self-hosted runner configured in an organization. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. ```js octokit.rest.actions.listLabelsForSelfHostedRunnerForOrg({ diff --git a/docs/actions/listLabelsForSelfHostedRunnerForRepo.md b/docs/actions/listLabelsForSelfHostedRunnerForRepo.md index fd60c97b5..cfe8cbe93 100644 --- a/docs/actions/listLabelsForSelfHostedRunnerForRepo.md +++ b/docs/actions/listLabelsForSelfHostedRunnerForRepo.md @@ -10,9 +10,9 @@ type: API method Lists all labels for a self-hosted runner configured in a repository. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.listLabelsForSelfHostedRunnerForRepo({ diff --git a/docs/actions/listOrgSecrets.md b/docs/actions/listOrgSecrets.md index e872ce756..3d89d6342 100644 --- a/docs/actions/listOrgSecrets.md +++ b/docs/actions/listOrgSecrets.md @@ -11,11 +11,10 @@ type: API method Lists all secrets available in an organization without revealing their encrypted values. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + ```js octokit.rest.actions.listOrgSecrets({ org, @@ -40,12 +39,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listOrgVariables.md b/docs/actions/listOrgVariables.md index 5be79fa84..0bde290c6 100644 --- a/docs/actions/listOrgVariables.md +++ b/docs/actions/listOrgVariables.md @@ -9,7 +9,10 @@ type: API method # List organization variables Lists all organization variables. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + +Authenticated users must have collaborator access to a repository to create, update, or read variables. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. ```js octokit.rest.actions.listOrgVariables({ @@ -35,12 +38,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 30). +The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listRepoOrganizationSecrets.md b/docs/actions/listRepoOrganizationSecrets.md index 001038d5a..9a8796b80 100644 --- a/docs/actions/listRepoOrganizationSecrets.md +++ b/docs/actions/listRepoOrganizationSecrets.md @@ -11,10 +11,10 @@ type: API method Lists all organization secrets shared with a repository without revealing their encrypted values. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.listRepoOrganizationSecrets({ owner, @@ -45,12 +45,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listRepoOrganizationVariables.md b/docs/actions/listRepoOrganizationVariables.md index c4bde519d..4621596ef 100644 --- a/docs/actions/listRepoOrganizationVariables.md +++ b/docs/actions/listRepoOrganizationVariables.md @@ -8,12 +8,12 @@ type: API method # List repository organization variables -Lists all organiation variables shared with a repository. +Lists all organization variables shared with a repository. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.listRepoOrganizationVariables({ owner, @@ -44,12 +44,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 30). +The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listRepoSecrets.md b/docs/actions/listRepoSecrets.md index a96289aad..85ac2c060 100644 --- a/docs/actions/listRepoSecrets.md +++ b/docs/actions/listRepoSecrets.md @@ -11,10 +11,10 @@ type: API method Lists all secrets available in a repository without revealing their encrypted values. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.listRepoSecrets({ owner, @@ -45,12 +45,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listRepoVariables.md b/docs/actions/listRepoVariables.md index 27e07dd48..e8499071f 100644 --- a/docs/actions/listRepoVariables.md +++ b/docs/actions/listRepoVariables.md @@ -9,10 +9,11 @@ type: API method # List repository variables Lists all repository variables. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.listRepoVariables({ owner, @@ -43,12 +44,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 30). +The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listRepoWorkflows.md b/docs/actions/listRepoWorkflows.md index 19e5dbf7a..378857b93 100644 --- a/docs/actions/listRepoWorkflows.md +++ b/docs/actions/listRepoWorkflows.md @@ -8,7 +8,11 @@ type: API method # List repository workflows -Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +Lists the workflows in a repository. + +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. ```js octokit.rest.actions.listRepoWorkflows({ @@ -40,12 +44,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listRunnerApplicationsForOrg.md b/docs/actions/listRunnerApplicationsForOrg.md index 919fad6df..679690dc9 100644 --- a/docs/actions/listRunnerApplicationsForOrg.md +++ b/docs/actions/listRunnerApplicationsForOrg.md @@ -10,10 +10,9 @@ type: API method Lists binaries for the runner application that you can download and run. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. ```js octokit.rest.actions.listRunnerApplicationsForOrg({ diff --git a/docs/actions/listRunnerApplicationsForRepo.md b/docs/actions/listRunnerApplicationsForRepo.md index 4fabecfc9..d6d0d1191 100644 --- a/docs/actions/listRunnerApplicationsForRepo.md +++ b/docs/actions/listRunnerApplicationsForRepo.md @@ -10,9 +10,9 @@ type: API method Lists binaries for the runner application that you can download and run. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.listRunnerApplicationsForRepo({ diff --git a/docs/actions/listSelectedReposForOrgSecret.md b/docs/actions/listSelectedReposForOrgSecret.md index 86fb5e587..a9e0d00ba 100644 --- a/docs/actions/listSelectedReposForOrgSecret.md +++ b/docs/actions/listSelectedReposForOrgSecret.md @@ -11,11 +11,10 @@ type: API method Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + ```js octokit.rest.actions.listSelectedReposForOrgSecret({ org, @@ -46,12 +45,12 @@ The name of the secret. pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listSelectedReposForOrgVariable.md b/docs/actions/listSelectedReposForOrgVariable.md index 763d7e035..e64981194 100644 --- a/docs/actions/listSelectedReposForOrgVariable.md +++ b/docs/actions/listSelectedReposForOrgVariable.md @@ -11,11 +11,10 @@ type: API method Lists all repositories that can access an organization variable that is available to selected repositories. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + ```js octokit.rest.actions.listSelectedReposForOrgVariable({ org, @@ -46,12 +45,12 @@ The name of the variable. pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listSelectedRepositoriesEnabledGithubActionsOrganization.md b/docs/actions/listSelectedRepositoriesEnabledGithubActionsOrganization.md index 8901dcaea..560d63771 100644 --- a/docs/actions/listSelectedRepositoriesEnabledGithubActionsOrganization.md +++ b/docs/actions/listSelectedRepositoriesEnabledGithubActionsOrganization.md @@ -10,7 +10,7 @@ type: API method Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." -You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.actions.listSelectedRepositoriesEnabledGithubActionsOrganization({ @@ -36,12 +36,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listSelfHostedRunnersForOrg.md b/docs/actions/listSelfHostedRunnersForOrg.md index 682f89436..2af86a618 100644 --- a/docs/actions/listSelfHostedRunnersForOrg.md +++ b/docs/actions/listSelfHostedRunnersForOrg.md @@ -10,10 +10,9 @@ type: API method Lists all self-hosted runners configured in an organization. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. ```js octokit.rest.actions.listSelfHostedRunnersForOrg({ @@ -44,12 +43,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listSelfHostedRunnersForRepo.md b/docs/actions/listSelfHostedRunnersForRepo.md index 0b5e58f2a..efa8b728e 100644 --- a/docs/actions/listSelfHostedRunnersForRepo.md +++ b/docs/actions/listSelfHostedRunnersForRepo.md @@ -10,9 +10,9 @@ type: API method Lists all self-hosted runners configured in a repository. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.listSelfHostedRunnersForRepo({ @@ -49,12 +49,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/actions/listWorkflowRunArtifacts.md b/docs/actions/listWorkflowRunArtifacts.md index 95d0e83ca..36564b10d 100644 --- a/docs/actions/listWorkflowRunArtifacts.md +++ b/docs/actions/listWorkflowRunArtifacts.md @@ -8,7 +8,11 @@ type: API method # List workflow run artifacts -Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +Lists artifacts for a workflow run. + +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. ```js octokit.rest.actions.listWorkflowRunArtifacts({ @@ -46,12 +50,12 @@ The unique identifier of the workflow run. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." nameno diff --git a/docs/actions/listWorkflowRuns.md b/docs/actions/listWorkflowRuns.md index 61cd64bee..dff3798ab 100644 --- a/docs/actions/listWorkflowRuns.md +++ b/docs/actions/listWorkflowRuns.md @@ -8,9 +8,11 @@ type: API method # List workflow runs for a workflow -List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). +List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). -Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. +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. ```js octokit.rest.actions.listWorkflowRuns({ @@ -68,12 +70,12 @@ Returns workflow runs with the check run `status` or `conclusion` that you speci per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." createdno diff --git a/docs/actions/listWorkflowRunsForRepo.md b/docs/actions/listWorkflowRunsForRepo.md index c5e6a8c75..55f1787a9 100644 --- a/docs/actions/listWorkflowRunsForRepo.md +++ b/docs/actions/listWorkflowRunsForRepo.md @@ -8,9 +8,11 @@ type: API method # List workflow runs for a repository -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/overview/resources-in-the-rest-api#parameters). +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). -Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +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. ```js octokit.rest.actions.listWorkflowRunsForRepo({ @@ -62,12 +64,12 @@ Returns workflow runs with the check run `status` or `conclusion` that you speci per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." createdno diff --git a/docs/actions/reRunJobForWorkflowRun.md b/docs/actions/reRunJobForWorkflowRun.md index be06aa2b3..72c2f77a5 100644 --- a/docs/actions/reRunJobForWorkflowRun.md +++ b/docs/actions/reRunJobForWorkflowRun.md @@ -10,8 +10,7 @@ type: API method Re-run a job and its dependent jobs in a workflow run. -You must authenticate using an access token with the `repo` scope to use this endpoint. -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.reRunJobForWorkflowRun({ diff --git a/docs/actions/reRunWorkflow.md b/docs/actions/reRunWorkflow.md index dd942236c..7616b6c5b 100644 --- a/docs/actions/reRunWorkflow.md +++ b/docs/actions/reRunWorkflow.md @@ -8,7 +8,9 @@ type: API method # Re-run a workflow -Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. +Re-runs your workflow run using its `id`. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.reRunWorkflow({ diff --git a/docs/actions/reRunWorkflowFailedJobs.md b/docs/actions/reRunWorkflowFailedJobs.md index c1edd2d51..7356c4922 100644 --- a/docs/actions/reRunWorkflowFailedJobs.md +++ b/docs/actions/reRunWorkflowFailedJobs.md @@ -8,7 +8,9 @@ type: API method # Re-run failed jobs from a workflow run -Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. +Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.reRunWorkflowFailedJobs({ diff --git a/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForOrg.md b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForOrg.md index 59a15a7d0..085b0ce81 100644 --- a/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForOrg.md +++ b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForOrg.md @@ -11,10 +11,9 @@ type: API method Remove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. ```js octokit.rest.actions.removeAllCustomLabelsFromSelfHostedRunnerForOrg({ diff --git a/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md index 4eac16911..1bdf2ad05 100644 --- a/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md +++ b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md @@ -11,9 +11,9 @@ type: API method Remove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.removeAllCustomLabelsFromSelfHostedRunnerForRepo({ diff --git a/docs/actions/removeCustomLabelFromSelfHostedRunnerForOrg.md b/docs/actions/removeCustomLabelFromSelfHostedRunnerForOrg.md index 6371d910c..38b327ef3 100644 --- a/docs/actions/removeCustomLabelFromSelfHostedRunnerForOrg.md +++ b/docs/actions/removeCustomLabelFromSelfHostedRunnerForOrg.md @@ -14,10 +14,9 @@ in an organization. Returns the remaining labels from the runner. This endpoint returns a `404 Not Found` status if the custom label is not present on the runner. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. ```js octokit.rest.actions.removeCustomLabelFromSelfHostedRunnerForOrg({ diff --git a/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md b/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md index 964e6e75b..eca7014e3 100644 --- a/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md +++ b/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md @@ -14,9 +14,9 @@ in a repository. Returns the remaining labels from the runner. This endpoint returns a `404 Not Found` status if the custom label is not present on the runner. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.removeCustomLabelFromSelfHostedRunnerForRepo({ diff --git a/docs/actions/removeSelectedRepoFromOrgSecret.md b/docs/actions/removeSelectedRepoFromOrgSecret.md index 146ffe89e..43d46780e 100644 --- a/docs/actions/removeSelectedRepoFromOrgSecret.md +++ b/docs/actions/removeSelectedRepoFromOrgSecret.md @@ -12,11 +12,10 @@ Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + ```js octokit.rest.actions.removeSelectedRepoFromOrgSecret({ org, diff --git a/docs/actions/removeSelectedRepoFromOrgVariable.md b/docs/actions/removeSelectedRepoFromOrgVariable.md index 3d00bfcb4..cc325c2fb 100644 --- a/docs/actions/removeSelectedRepoFromOrgVariable.md +++ b/docs/actions/removeSelectedRepoFromOrgVariable.md @@ -12,11 +12,10 @@ Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + ```js octokit.rest.actions.removeSelectedRepoFromOrgVariable({ org, diff --git a/docs/actions/reviewCustomGatesForRun.md b/docs/actions/reviewCustomGatesForRun.md index ce47c253a..cc8c07509 100644 --- a/docs/actions/reviewCustomGatesForRun.md +++ b/docs/actions/reviewCustomGatesForRun.md @@ -13,8 +13,7 @@ Approve or reject custom deployment protection rules provided by a GitHub App fo **Note:** GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have read and write permission for **Deployments** to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. ```js octokit.rest.actions.reviewCustomGatesForRun({ diff --git a/docs/actions/reviewPendingDeploymentsForRun.md b/docs/actions/reviewPendingDeploymentsForRun.md index fc80d301a..4e68f4ef8 100644 --- a/docs/actions/reviewPendingDeploymentsForRun.md +++ b/docs/actions/reviewPendingDeploymentsForRun.md @@ -10,7 +10,9 @@ type: API method Approve or reject pending deployments that are waiting on approval by a required reviewer. -Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint. +Required reviewers with read access to the repository contents and deployments can use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.reviewPendingDeploymentsForRun({ diff --git a/docs/actions/setAllowedActionsOrganization.md b/docs/actions/setAllowedActionsOrganization.md index dec99c87d..26af0b3d6 100644 --- a/docs/actions/setAllowedActionsOrganization.md +++ b/docs/actions/setAllowedActionsOrganization.md @@ -10,7 +10,7 @@ type: API method Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." -You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.actions.setAllowedActionsOrganization({ diff --git a/docs/actions/setAllowedActionsRepository.md b/docs/actions/setAllowedActionsRepository.md index 58a26f63c..b0334cd53 100644 --- a/docs/actions/setAllowedActionsRepository.md +++ b/docs/actions/setAllowedActionsRepository.md @@ -10,7 +10,7 @@ type: API method Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.setAllowedActionsRepository({ diff --git a/docs/actions/setCustomLabelsForSelfHostedRunnerForOrg.md b/docs/actions/setCustomLabelsForSelfHostedRunnerForOrg.md index 9f5a903ec..a6fc452fe 100644 --- a/docs/actions/setCustomLabelsForSelfHostedRunnerForOrg.md +++ b/docs/actions/setCustomLabelsForSelfHostedRunnerForOrg.md @@ -11,10 +11,9 @@ type: API method Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. ```js octokit.rest.actions.setCustomLabelsForSelfHostedRunnerForOrg({ diff --git a/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md b/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md index d54edc1c8..352b51997 100644 --- a/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md +++ b/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md @@ -11,9 +11,9 @@ type: API method Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. -Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. +Authenticated users must have admin access to the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.setCustomLabelsForSelfHostedRunnerForRepo({ diff --git a/docs/actions/setGithubActionsDefaultWorkflowPermissionsOrganization.md b/docs/actions/setGithubActionsDefaultWorkflowPermissionsOrganization.md index dd6d783d9..ef0786c10 100644 --- a/docs/actions/setGithubActionsDefaultWorkflowPermissionsOrganization.md +++ b/docs/actions/setGithubActionsDefaultWorkflowPermissionsOrganization.md @@ -12,7 +12,7 @@ Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." -You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.actions.setGithubActionsDefaultWorkflowPermissionsOrganization({ diff --git a/docs/actions/setGithubActionsDefaultWorkflowPermissionsRepository.md b/docs/actions/setGithubActionsDefaultWorkflowPermissionsRepository.md index 6424d4164..d05f93d39 100644 --- a/docs/actions/setGithubActionsDefaultWorkflowPermissionsRepository.md +++ b/docs/actions/setGithubActionsDefaultWorkflowPermissionsRepository.md @@ -12,7 +12,7 @@ Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.setGithubActionsDefaultWorkflowPermissionsRepository({ diff --git a/docs/actions/setGithubActionsPermissionsOrganization.md b/docs/actions/setGithubActionsPermissionsOrganization.md index ccd42aec0..a8b64e453 100644 --- a/docs/actions/setGithubActionsPermissionsOrganization.md +++ b/docs/actions/setGithubActionsPermissionsOrganization.md @@ -10,7 +10,7 @@ type: API method Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.actions.setGithubActionsPermissionsOrganization({ diff --git a/docs/actions/setGithubActionsPermissionsRepository.md b/docs/actions/setGithubActionsPermissionsRepository.md index 05f3bdb99..150875602 100644 --- a/docs/actions/setGithubActionsPermissionsRepository.md +++ b/docs/actions/setGithubActionsPermissionsRepository.md @@ -10,7 +10,7 @@ type: API method Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.setGithubActionsPermissionsRepository({ diff --git a/docs/actions/setSelectedReposForOrgSecret.md b/docs/actions/setSelectedReposForOrgSecret.md index 54037a3ad..57d94adf6 100644 --- a/docs/actions/setSelectedReposForOrgSecret.md +++ b/docs/actions/setSelectedReposForOrgSecret.md @@ -12,11 +12,10 @@ Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + ```js octokit.rest.actions.setSelectedReposForOrgSecret({ org, diff --git a/docs/actions/setSelectedReposForOrgVariable.md b/docs/actions/setSelectedReposForOrgVariable.md index 019a24f48..c16da7b5e 100644 --- a/docs/actions/setSelectedReposForOrgVariable.md +++ b/docs/actions/setSelectedReposForOrgVariable.md @@ -12,12 +12,10 @@ Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `organization_actions_variables:write` organization permission to use this -endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + ```js octokit.rest.actions.setSelectedReposForOrgVariable({ org, diff --git a/docs/actions/setSelectedRepositoriesEnabledGithubActionsOrganization.md b/docs/actions/setSelectedRepositoriesEnabledGithubActionsOrganization.md index d1958189f..0e107dce9 100644 --- a/docs/actions/setSelectedRepositoriesEnabledGithubActionsOrganization.md +++ b/docs/actions/setSelectedRepositoriesEnabledGithubActionsOrganization.md @@ -10,7 +10,7 @@ type: API method Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." -You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.actions.setSelectedRepositoriesEnabledGithubActionsOrganization({ diff --git a/docs/actions/setWorkflowAccessToRepository.md b/docs/actions/setWorkflowAccessToRepository.md index e237b5125..14e83918d 100644 --- a/docs/actions/setWorkflowAccessToRepository.md +++ b/docs/actions/setWorkflowAccessToRepository.md @@ -12,8 +12,7 @@ Sets the level of access that workflows outside of the repository have to action This endpoint only applies to private repositories. For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the -repository `administration` permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.setWorkflowAccessToRepository({ @@ -49,7 +48,7 @@ The name of the repository without the `.git` extension. The name is not case se Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the repository. -`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization. +`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. diff --git a/docs/actions/updateEnvironmentVariable.md b/docs/actions/updateEnvironmentVariable.md index a326b5326..5255364d4 100644 --- a/docs/actions/updateEnvironmentVariable.md +++ b/docs/actions/updateEnvironmentVariable.md @@ -10,10 +10,10 @@ type: API method Updates an environment variable that you can reference in a GitHub Actions workflow. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `environment:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.updateEnvironmentVariable({ repository_id, @@ -44,7 +44,7 @@ The name of the variable. environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. valueno diff --git a/docs/actions/updateOrgVariable.md b/docs/actions/updateOrgVariable.md index 856dc83ee..ee07e64df 100644 --- a/docs/actions/updateOrgVariable.md +++ b/docs/actions/updateOrgVariable.md @@ -10,11 +10,10 @@ type: API method Updates an organization variable that you can reference in a GitHub Actions workflow. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. -GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + ```js octokit.rest.actions.updateOrgVariable({ org, diff --git a/docs/actions/updateRepoVariable.md b/docs/actions/updateRepoVariable.md index e72aeca7c..e0fc87d4f 100644 --- a/docs/actions/updateRepoVariable.md +++ b/docs/actions/updateRepoVariable.md @@ -10,10 +10,10 @@ type: API method Updates a repository variable that you can reference in a GitHub Actions workflow. -You must authenticate using an access token with the `repo` scope to use this endpoint. -GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.actions.updateRepoVariable({ owner, diff --git a/docs/activity/getFeeds.md b/docs/activity/getFeeds.md index 21a504666..a0049f9b0 100644 --- a/docs/activity/getFeeds.md +++ b/docs/activity/getFeeds.md @@ -11,7 +11,7 @@ type: API method GitHub provides several timeline resources in [Atom]() format. The Feeds API lists all the feeds available to the authenticated user: - **Timeline**: The GitHub global public timeline -- **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) +- **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)." - **Current user public**: The public timeline for the authenticated user - **Current user**: The private timeline for the authenticated user - **Current user actor**: The private timeline for activity created by the authenticated user diff --git a/docs/activity/listEventsForAuthenticatedUser.md b/docs/activity/listEventsForAuthenticatedUser.md index 8bd9872a8..cea03c130 100644 --- a/docs/activity/listEventsForAuthenticatedUser.md +++ b/docs/activity/listEventsForAuthenticatedUser.md @@ -34,12 +34,12 @@ The handle for the GitHub user account. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listNotificationsForAuthenticatedUser.md b/docs/activity/listNotificationsForAuthenticatedUser.md index 7f455b018..4cd1b26c4 100644 --- a/docs/activity/listNotificationsForAuthenticatedUser.md +++ b/docs/activity/listNotificationsForAuthenticatedUser.md @@ -47,12 +47,12 @@ Only show notifications updated before the given time. This is a timestamp in [I pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 50). +The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listOrgEventsForAuthenticatedUser.md b/docs/activity/listOrgEventsForAuthenticatedUser.md index 395fe4df4..068d921de 100644 --- a/docs/activity/listOrgEventsForAuthenticatedUser.md +++ b/docs/activity/listOrgEventsForAuthenticatedUser.md @@ -40,12 +40,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listPublicEvents.md b/docs/activity/listPublicEvents.md index c6f45592d..5f635361a 100644 --- a/docs/activity/listPublicEvents.md +++ b/docs/activity/listPublicEvents.md @@ -27,12 +27,12 @@ octokit.rest.activity.listPublicEvents(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listPublicEventsForRepoNetwork.md b/docs/activity/listPublicEventsForRepoNetwork.md index 707c518b7..bb274a414 100644 --- a/docs/activity/listPublicEventsForRepoNetwork.md +++ b/docs/activity/listPublicEventsForRepoNetwork.md @@ -38,12 +38,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listPublicEventsForUser.md b/docs/activity/listPublicEventsForUser.md index f72fecfd1..f050a25c3 100644 --- a/docs/activity/listPublicEventsForUser.md +++ b/docs/activity/listPublicEventsForUser.md @@ -32,12 +32,12 @@ The handle for the GitHub user account. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listPublicOrgEvents.md b/docs/activity/listPublicOrgEvents.md index 4c4ead57d..31ed929f3 100644 --- a/docs/activity/listPublicOrgEvents.md +++ b/docs/activity/listPublicOrgEvents.md @@ -32,12 +32,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listReceivedEventsForUser.md b/docs/activity/listReceivedEventsForUser.md index 6dcc67243..e3066c952 100644 --- a/docs/activity/listReceivedEventsForUser.md +++ b/docs/activity/listReceivedEventsForUser.md @@ -8,7 +8,7 @@ type: API method # List events received by the authenticated user -These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. +These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. ```js octokit.rest.activity.listReceivedEventsForUser({ @@ -34,12 +34,12 @@ The handle for the GitHub user account. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listReceivedPublicEventsForUser.md b/docs/activity/listReceivedPublicEventsForUser.md index ee944b055..4521952ce 100644 --- a/docs/activity/listReceivedPublicEventsForUser.md +++ b/docs/activity/listReceivedPublicEventsForUser.md @@ -32,12 +32,12 @@ The handle for the GitHub user account. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listRepoEvents.md b/docs/activity/listRepoEvents.md index 99f5bebda..bc845f268 100644 --- a/docs/activity/listRepoEvents.md +++ b/docs/activity/listRepoEvents.md @@ -40,12 +40,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listRepoNotificationsForAuthenticatedUser.md b/docs/activity/listRepoNotificationsForAuthenticatedUser.md index 1a10bda28..b6505a926 100644 --- a/docs/activity/listRepoNotificationsForAuthenticatedUser.md +++ b/docs/activity/listRepoNotificationsForAuthenticatedUser.md @@ -60,12 +60,12 @@ Only show notifications updated before the given time. This is a timestamp in [I per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listReposStarredByAuthenticatedUser.md b/docs/activity/listReposStarredByAuthenticatedUser.md index a5170ff95..3af3403ee 100644 --- a/docs/activity/listReposStarredByAuthenticatedUser.md +++ b/docs/activity/listReposStarredByAuthenticatedUser.md @@ -10,7 +10,9 @@ type: API method Lists repositories the authenticated user has starred. -You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. +This 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)." + +- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. ```js octokit.rest.activity.listReposStarredByAuthenticatedUser(); @@ -39,12 +41,12 @@ The direction to sort the results by. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listReposStarredByUser.md b/docs/activity/listReposStarredByUser.md index e2d0df326..0a19fd0fc 100644 --- a/docs/activity/listReposStarredByUser.md +++ b/docs/activity/listReposStarredByUser.md @@ -10,7 +10,9 @@ type: API method Lists repositories a user has starred. -You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. +This 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)." + +- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. ```js octokit.rest.activity.listReposStarredByUser({ @@ -46,12 +48,12 @@ The direction to sort the results by. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listReposWatchedByUser.md b/docs/activity/listReposWatchedByUser.md index daf0dff7c..b4d052353 100644 --- a/docs/activity/listReposWatchedByUser.md +++ b/docs/activity/listReposWatchedByUser.md @@ -34,12 +34,12 @@ The handle for the GitHub user account. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listStargazersForRepo.md b/docs/activity/listStargazersForRepo.md index 308d5184d..c98ae4514 100644 --- a/docs/activity/listStargazersForRepo.md +++ b/docs/activity/listStargazersForRepo.md @@ -10,7 +10,9 @@ type: API method Lists the people that have starred the repository. -You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. +This 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)." + +- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. ```js octokit.rest.activity.listStargazersForRepo({ @@ -42,12 +44,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listWatchedReposForAuthenticatedUser.md b/docs/activity/listWatchedReposForAuthenticatedUser.md index 0d6b9d59c..8dcb00305 100644 --- a/docs/activity/listWatchedReposForAuthenticatedUser.md +++ b/docs/activity/listWatchedReposForAuthenticatedUser.md @@ -27,12 +27,12 @@ octokit.rest.activity.listWatchedReposForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/listWatchersForRepo.md b/docs/activity/listWatchersForRepo.md index 3c278d487..b48aa9f30 100644 --- a/docs/activity/listWatchersForRepo.md +++ b/docs/activity/listWatchersForRepo.md @@ -40,12 +40,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/activity/markThreadAsDone.md b/docs/activity/markThreadAsDone.md new file mode 100644 index 000000000..bbb20f68a --- /dev/null +++ b/docs/activity/markThreadAsDone.md @@ -0,0 +1,38 @@ +--- +name: Mark a thread as done +example: octokit.rest.activity.markThreadAsDone({ thread_id }) +route: DELETE /notifications/threads/{thread_id} +scope: activity +type: API method +--- + +# Mark a thread as done + +Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications. + +```js +octokit.rest.activity.markThreadAsDone({ + thread_id, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
thread_idyes + +The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done). diff --git a/docs/activity/starRepoForAuthenticatedUser.md b/docs/activity/starRepoForAuthenticatedUser.md index 040679460..8a94673f0 100644 --- a/docs/activity/starRepoForAuthenticatedUser.md +++ b/docs/activity/starRepoForAuthenticatedUser.md @@ -8,7 +8,7 @@ type: API method # Star a repository for the authenticated user -Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." +Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." ```js octokit.rest.activity.starRepoForAuthenticatedUser({ diff --git a/docs/apps/addRepoToInstallation.md b/docs/apps/addRepoToInstallation.md index acd793473..627e320ba 100644 --- a/docs/apps/addRepoToInstallation.md +++ b/docs/apps/addRepoToInstallation.md @@ -12,8 +12,6 @@ type: API method Add a single repository to an installation. The authenticated user must have admin access to the repository. -You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - ```js octokit.rest.apps.addRepoToInstallation({ installation_id, diff --git a/docs/apps/addRepoToInstallationForAuthenticatedUser.md b/docs/apps/addRepoToInstallationForAuthenticatedUser.md index 55e21989d..65a04dccb 100644 --- a/docs/apps/addRepoToInstallationForAuthenticatedUser.md +++ b/docs/apps/addRepoToInstallationForAuthenticatedUser.md @@ -10,8 +10,6 @@ type: API method Add a single repository to an installation. The authenticated user must have admin access to the repository. -You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - ```js octokit.rest.apps.addRepoToInstallationForAuthenticatedUser({ installation_id, diff --git a/docs/apps/createInstallationAccessToken.md b/docs/apps/createInstallationAccessToken.md index 4d2c84b82..1f7ae95fb 100644 --- a/docs/apps/createInstallationAccessToken.md +++ b/docs/apps/createInstallationAccessToken.md @@ -8,7 +8,13 @@ type: API method # Create an installation access token for an app -Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. +Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. + +Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + +Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. + +When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. @@ -63,11 +69,21 @@ The level of permission to grant the access token for repository creation, delet The level of permission to grant the access token for checks on code. + +permissions.codespacesno + +The level of permission to grant the access token to create, edit, delete, and list Codespaces. + permissions.contentsno The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. + +permissions.dependabot_secretsno + +The leve of permission to grant the access token to manage Dependabot secrets. + permissions.deploymentsno @@ -103,6 +119,11 @@ The level of permission to grant the access token to retrieve Pages statuses, co The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. + +permissions.repository_custom_propertiesno + +The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. + permissions.repository_hooksno @@ -161,18 +182,33 @@ The level of permission to grant the access token to manage access to an organiz permissions.organization_custom_rolesno -The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change. +The level of permission to grant the access token for custom repository roles management. + + +permissions.organization_custom_org_rolesno + +The level of permission to grant the access token for custom organization roles management. permissions.organization_custom_propertiesno The level of permission to grant the access token for custom property management. + +permissions.organization_copilot_seat_managementno + +The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + permissions.organization_announcement_bannersno The level of permission to grant the access token to view and manage announcement banners for an organization. + +permissions.organization_eventsno + +The level of permission to grant the access token to view events triggered by an activity in an organization. + permissions.organization_hooksno @@ -223,6 +259,41 @@ The level of permission to grant the access token to view and manage users block The level of permission to grant the access token to manage team discussions and related comments. + +permissions.email_addressesno + +The level of permission to grant the access token to manage the email addresses belonging to a user. + + +permissions.followersno + +The level of permission to grant the access token to manage the followers belonging to a user. + + +permissions.git_ssh_keysno + +The level of permission to grant the access token to manage git SSH keys. + + +permissions.gpg_keysno + +The level of permission to grant the access token to view and manage GPG keys belonging to a user. + + +permissions.interaction_limitsno + +The level of permission to grant the access token to view and manage interaction limits on a repository. + + +permissions.profileno + +The level of permission to grant the access token to manage the profile settings belonging to a user. + + +permissions.starringno + +The level of permission to grant the access token to list and manage repositories a user is starring. + diff --git a/docs/apps/getBySlug.md b/docs/apps/getBySlug.md index 2cf95fc53..8d260e5d1 100644 --- a/docs/apps/getBySlug.md +++ b/docs/apps/getBySlug.md @@ -10,8 +10,6 @@ type: API method **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). -If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - ```js octokit.rest.apps.getBySlug({ app_slug, diff --git a/docs/apps/listAccountsForPlan.md b/docs/apps/listAccountsForPlan.md index e507826f1..c4003c7e3 100644 --- a/docs/apps/listAccountsForPlan.md +++ b/docs/apps/listAccountsForPlan.md @@ -46,12 +46,12 @@ To return the oldest accounts first, set to `asc`. Ignored without the `sort` pa per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/apps/listAccountsForPlanStubbed.md b/docs/apps/listAccountsForPlanStubbed.md index 3df597334..a48a625db 100644 --- a/docs/apps/listAccountsForPlanStubbed.md +++ b/docs/apps/listAccountsForPlanStubbed.md @@ -46,12 +46,12 @@ To return the oldest accounts first, set to `asc`. Ignored without the `sort` pa per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/apps/listInstallationReposForAuthenticatedUser.md b/docs/apps/listInstallationReposForAuthenticatedUser.md index 119d1e8d5..4cd7c7d0c 100644 --- a/docs/apps/listInstallationReposForAuthenticatedUser.md +++ b/docs/apps/listInstallationReposForAuthenticatedUser.md @@ -12,8 +12,6 @@ List repositories that the authenticated user has explicit permission (`:read`, The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. -You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - The access the user has to each repository is included in the hash under the `permissions` key. ```js @@ -40,12 +38,12 @@ The unique identifier of the installation. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/apps/listInstallationRequestsForAuthenticatedApp.md b/docs/apps/listInstallationRequestsForAuthenticatedApp.md index 02fbd7e18..3f3ee08fb 100644 --- a/docs/apps/listInstallationRequestsForAuthenticatedApp.md +++ b/docs/apps/listInstallationRequestsForAuthenticatedApp.md @@ -27,12 +27,12 @@ octokit.rest.apps.listInstallationRequestsForAuthenticatedApp(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/apps/listInstallationsForAuthenticatedUser.md b/docs/apps/listInstallationsForAuthenticatedUser.md index 93a86a35e..3a6cb47a3 100644 --- a/docs/apps/listInstallationsForAuthenticatedUser.md +++ b/docs/apps/listInstallationsForAuthenticatedUser.md @@ -10,8 +10,6 @@ type: API method Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. -You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. You can find the permissions for the installation under the `permissions` key. @@ -33,12 +31,12 @@ octokit.rest.apps.listInstallationsForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/apps/listPlans.md b/docs/apps/listPlans.md index 533840f36..864079521 100644 --- a/docs/apps/listPlans.md +++ b/docs/apps/listPlans.md @@ -29,12 +29,12 @@ octokit.rest.apps.listPlans(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/apps/listPlansStubbed.md b/docs/apps/listPlansStubbed.md index 4fa2efadb..47dca4abc 100644 --- a/docs/apps/listPlansStubbed.md +++ b/docs/apps/listPlansStubbed.md @@ -29,12 +29,12 @@ octokit.rest.apps.listPlansStubbed(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/apps/listReposAccessibleToInstallation.md b/docs/apps/listReposAccessibleToInstallation.md index 903b9cbbd..d7b358259 100644 --- a/docs/apps/listReposAccessibleToInstallation.md +++ b/docs/apps/listReposAccessibleToInstallation.md @@ -10,8 +10,6 @@ type: API method List repositories that an app installation can access. -You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - ```js octokit.rest.apps.listReposAccessibleToInstallation(); ``` @@ -29,12 +27,12 @@ octokit.rest.apps.listReposAccessibleToInstallation(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/apps/listSubscriptionsForAuthenticatedUser.md b/docs/apps/listSubscriptionsForAuthenticatedUser.md index 48233f578..fe6e96e60 100644 --- a/docs/apps/listSubscriptionsForAuthenticatedUser.md +++ b/docs/apps/listSubscriptionsForAuthenticatedUser.md @@ -8,7 +8,7 @@ type: API method # List subscriptions for the authenticated user -Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). +Lists the active subscriptions for the authenticated user. ```js octokit.rest.apps.listSubscriptionsForAuthenticatedUser(); @@ -27,12 +27,12 @@ octokit.rest.apps.listSubscriptionsForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/apps/listSubscriptionsForAuthenticatedUserStubbed.md b/docs/apps/listSubscriptionsForAuthenticatedUserStubbed.md index 524d4c23b..38ae557d0 100644 --- a/docs/apps/listSubscriptionsForAuthenticatedUserStubbed.md +++ b/docs/apps/listSubscriptionsForAuthenticatedUserStubbed.md @@ -8,7 +8,7 @@ type: API method # List subscriptions for the authenticated user (stubbed) -Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). +Lists the active subscriptions for the authenticated user. ```js octokit.rest.apps.listSubscriptionsForAuthenticatedUserStubbed(); @@ -27,12 +27,12 @@ octokit.rest.apps.listSubscriptionsForAuthenticatedUserStubbed(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/apps/listWebhookDeliveries.md b/docs/apps/listWebhookDeliveries.md index ef2a51bad..4b0ab4426 100644 --- a/docs/apps/listWebhookDeliveries.md +++ b/docs/apps/listWebhookDeliveries.md @@ -29,7 +29,7 @@ octokit.rest.apps.listWebhookDeliveries(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." cursorno diff --git a/docs/apps/removeRepoFromInstallation.md b/docs/apps/removeRepoFromInstallation.md index 28dc8a963..2eaaf85b2 100644 --- a/docs/apps/removeRepoFromInstallation.md +++ b/docs/apps/removeRepoFromInstallation.md @@ -12,8 +12,6 @@ type: API method Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. -You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - ```js octokit.rest.apps.removeRepoFromInstallation({ installation_id, diff --git a/docs/apps/removeRepoFromInstallationForAuthenticatedUser.md b/docs/apps/removeRepoFromInstallationForAuthenticatedUser.md index ecdb7b821..9e7781bdc 100644 --- a/docs/apps/removeRepoFromInstallationForAuthenticatedUser.md +++ b/docs/apps/removeRepoFromInstallationForAuthenticatedUser.md @@ -10,8 +10,6 @@ type: API method Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. -You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - ```js octokit.rest.apps.removeRepoFromInstallationForAuthenticatedUser({ installation_id, diff --git a/docs/apps/revokeInstallationAccessToken.md b/docs/apps/revokeInstallationAccessToken.md index 14f4e2e3d..75f585562 100644 --- a/docs/apps/revokeInstallationAccessToken.md +++ b/docs/apps/revokeInstallationAccessToken.md @@ -12,8 +12,6 @@ Revokes the installation token you're using to authenticate as an installation a Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. -You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - ```js octokit.rest.apps.revokeInstallationAccessToken(); ``` diff --git a/docs/apps/scopeToken.md b/docs/apps/scopeToken.md index 9fc842593..3902a3687 100644 --- a/docs/apps/scopeToken.md +++ b/docs/apps/scopeToken.md @@ -8,7 +8,15 @@ type: API method # Create a scoped access token -Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. +Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify +which repositories the token can access and which permissions are granted to the +token. + +Invalid tokens will return `404 NOT FOUND`. + +You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) +when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App +as the username and password. ```js octokit.rest.apps.scopeToken({ @@ -77,11 +85,21 @@ The level of permission to grant the access token for repository creation, delet The level of permission to grant the access token for checks on code. + +permissions.codespacesno + +The level of permission to grant the access token to create, edit, delete, and list Codespaces. + permissions.contentsno The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. + +permissions.dependabot_secretsno + +The leve of permission to grant the access token to manage Dependabot secrets. + permissions.deploymentsno @@ -117,6 +135,11 @@ The level of permission to grant the access token to retrieve Pages statuses, co The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. + +permissions.repository_custom_propertiesno + +The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. + permissions.repository_hooksno @@ -175,18 +198,33 @@ The level of permission to grant the access token to manage access to an organiz permissions.organization_custom_rolesno -The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change. +The level of permission to grant the access token for custom repository roles management. + + +permissions.organization_custom_org_rolesno + +The level of permission to grant the access token for custom organization roles management. permissions.organization_custom_propertiesno The level of permission to grant the access token for custom property management. + +permissions.organization_copilot_seat_managementno + +The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + permissions.organization_announcement_bannersno The level of permission to grant the access token to view and manage announcement banners for an organization. + +permissions.organization_eventsno + +The level of permission to grant the access token to view events triggered by an activity in an organization. + permissions.organization_hooksno @@ -237,6 +275,41 @@ The level of permission to grant the access token to view and manage users block The level of permission to grant the access token to manage team discussions and related comments. + +permissions.email_addressesno + +The level of permission to grant the access token to manage the email addresses belonging to a user. + + +permissions.followersno + +The level of permission to grant the access token to manage the followers belonging to a user. + + +permissions.git_ssh_keysno + +The level of permission to grant the access token to manage git SSH keys. + + +permissions.gpg_keysno + +The level of permission to grant the access token to view and manage GPG keys belonging to a user. + + +permissions.interaction_limitsno + +The level of permission to grant the access token to view and manage interaction limits on a repository. + + +permissions.profileno + +The level of permission to grant the access token to manage the profile settings belonging to a user. + + +permissions.starringno + +The level of permission to grant the access token to list and manage repositories a user is starring. + diff --git a/docs/billing/getGithubActionsBillingOrg.md b/docs/billing/getGithubActionsBillingOrg.md index 23fba2ea1..60524bf96 100644 --- a/docs/billing/getGithubActionsBillingOrg.md +++ b/docs/billing/getGithubActionsBillingOrg.md @@ -12,7 +12,7 @@ Gets the summary of the free and paid GitHub Actions minutes used. Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". -Access tokens must have the `repo` or `admin:org` scope. +OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. ```js octokit.rest.billing.getGithubActionsBillingOrg({ diff --git a/docs/billing/getGithubActionsBillingUser.md b/docs/billing/getGithubActionsBillingUser.md index a95b3abce..fc9e41093 100644 --- a/docs/billing/getGithubActionsBillingUser.md +++ b/docs/billing/getGithubActionsBillingUser.md @@ -12,7 +12,7 @@ Gets the summary of the free and paid GitHub Actions minutes used. Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". -Access tokens must have the `user` scope. +OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. ```js octokit.rest.billing.getGithubActionsBillingUser({ diff --git a/docs/billing/getGithubPackagesBillingOrg.md b/docs/billing/getGithubPackagesBillingOrg.md index 3feb379a9..3a599e066 100644 --- a/docs/billing/getGithubPackagesBillingOrg.md +++ b/docs/billing/getGithubPackagesBillingOrg.md @@ -12,7 +12,7 @@ Gets the free and paid storage used for GitHub Packages in gigabytes. Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." -Access tokens must have the `repo` or `admin:org` scope. +OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. ```js octokit.rest.billing.getGithubPackagesBillingOrg({ diff --git a/docs/billing/getGithubPackagesBillingUser.md b/docs/billing/getGithubPackagesBillingUser.md index c62cc6fb4..d90e56ccf 100644 --- a/docs/billing/getGithubPackagesBillingUser.md +++ b/docs/billing/getGithubPackagesBillingUser.md @@ -12,7 +12,7 @@ Gets the free and paid storage used for GitHub Packages in gigabytes. Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." -Access tokens must have the `user` scope. +OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. ```js octokit.rest.billing.getGithubPackagesBillingUser({ diff --git a/docs/billing/getSharedStorageBillingOrg.md b/docs/billing/getSharedStorageBillingOrg.md index a2f4844e9..0e9c89984 100644 --- a/docs/billing/getSharedStorageBillingOrg.md +++ b/docs/billing/getSharedStorageBillingOrg.md @@ -12,7 +12,7 @@ Gets the estimated paid and estimated total storage used for GitHub Actions and Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." -Access tokens must have the `repo` or `admin:org` scope. +OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. ```js octokit.rest.billing.getSharedStorageBillingOrg({ diff --git a/docs/billing/getSharedStorageBillingUser.md b/docs/billing/getSharedStorageBillingUser.md index a576d1e89..869280a8f 100644 --- a/docs/billing/getSharedStorageBillingUser.md +++ b/docs/billing/getSharedStorageBillingUser.md @@ -12,7 +12,7 @@ Gets the estimated paid and estimated total storage used for GitHub Actions and Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." -Access tokens must have the `user` scope. +OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. ```js octokit.rest.billing.getSharedStorageBillingUser({ diff --git a/docs/checks/createSuite.md b/docs/checks/createSuite.md index dcbe9f621..3b46a5023 100644 --- a/docs/checks/createSuite.md +++ b/docs/checks/createSuite.md @@ -8,9 +8,11 @@ type: API method # Create a check suite +Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". + **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. -By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. +OAuth apps and personal access tokens (classic) cannot use this endpoint. ```js octokit.rest.checks.createSuite({ diff --git a/docs/checks/get.md b/docs/checks/get.md index 18f73a394..301edc69b 100644 --- a/docs/checks/get.md +++ b/docs/checks/get.md @@ -8,9 +8,11 @@ type: API method # Get a check run +Gets a single check run using its `id`. + **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. -Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. ```js octokit.rest.checks.get({ diff --git a/docs/checks/getSuite.md b/docs/checks/getSuite.md index 0869ba178..25c965830 100644 --- a/docs/checks/getSuite.md +++ b/docs/checks/getSuite.md @@ -8,9 +8,11 @@ type: API method # Get a check suite +Gets a single check suite using its `id`. + **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. -Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. ```js octokit.rest.checks.getSuite({ diff --git a/docs/checks/listAnnotations.md b/docs/checks/listAnnotations.md index d5c741c12..d497aae3e 100644 --- a/docs/checks/listAnnotations.md +++ b/docs/checks/listAnnotations.md @@ -8,7 +8,9 @@ type: API method # List check run annotations -Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. +Lists annotations for a check run using the annotation `id`. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. ```js octokit.rest.checks.listAnnotations({ @@ -46,12 +48,12 @@ The unique identifier of the check run. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/checks/listForRef.md b/docs/checks/listForRef.md index 027329ff4..b6790a5b2 100644 --- a/docs/checks/listForRef.md +++ b/docs/checks/listForRef.md @@ -8,12 +8,14 @@ type: API method # List check runs for a Git reference -Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. +Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + ```js octokit.rest.checks.listForRef({ owner, @@ -65,12 +67,12 @@ Filters check runs by their `completed_at` timestamp. `latest` returns the most per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." app_idno diff --git a/docs/checks/listForSuite.md b/docs/checks/listForSuite.md index 954f236d9..87392143f 100644 --- a/docs/checks/listForSuite.md +++ b/docs/checks/listForSuite.md @@ -8,10 +8,12 @@ type: API method # List check runs in a check suite -Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. +Lists check runs for a check suite using its `id`. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + ```js octokit.rest.checks.listForSuite({ owner, @@ -63,12 +65,12 @@ Filters check runs by their `completed_at` timestamp. `latest` returns the most per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/checks/listSuitesForRef.md b/docs/checks/listSuitesForRef.md index 09c920501..c97e4d69d 100644 --- a/docs/checks/listSuitesForRef.md +++ b/docs/checks/listSuitesForRef.md @@ -8,10 +8,12 @@ type: API method # List check suites for a Git reference -Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. +Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + ```js octokit.rest.checks.listSuitesForRef({ owner, @@ -58,12 +60,12 @@ Returns check runs with the specified `name`. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/checks/rerequestRun.md b/docs/checks/rerequestRun.md index 8f53c4c07..1b6162d79 100644 --- a/docs/checks/rerequestRun.md +++ b/docs/checks/rerequestRun.md @@ -10,10 +10,10 @@ type: API method Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. -To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. - For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". +OAuth apps and personal access tokens (classic) cannot use this endpoint. + ```js octokit.rest.checks.rerequestRun({ owner, diff --git a/docs/checks/rerequestSuite.md b/docs/checks/rerequestSuite.md index 5c2115389..70f6e9d9d 100644 --- a/docs/checks/rerequestSuite.md +++ b/docs/checks/rerequestSuite.md @@ -10,7 +10,7 @@ type: API method Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. -To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository. +OAuth apps and personal access tokens (classic) cannot use this endpoint. ```js octokit.rest.checks.rerequestSuite({ diff --git a/docs/checks/setSuitesPreferences.md b/docs/checks/setSuitesPreferences.md index ca0072328..c6f86f6ad 100644 --- a/docs/checks/setSuitesPreferences.md +++ b/docs/checks/setSuitesPreferences.md @@ -8,7 +8,8 @@ type: API method # Update repository preferences for check suites -Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. +Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). +You must have admin permissions in the repository to set preferences for check suites. ```js octokit.rest.checks.setSuitesPreferences({ diff --git a/docs/checks/update.md b/docs/checks/update.md index e2e2c3979..9384667be 100644 --- a/docs/checks/update.md +++ b/docs/checks/update.md @@ -8,10 +8,12 @@ type: API method # Update a check run -Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. +Updates a check run for a specific commit in a repository. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. +OAuth apps and personal access tokens (classic) cannot use this endpoint. + ```js octokit.rest.checks.update({ owner, diff --git a/docs/codeScanning/deleteAnalysis.md b/docs/codeScanning/deleteAnalysis.md index 98dbba8d5..a5a8cea80 100644 --- a/docs/codeScanning/deleteAnalysis.md +++ b/docs/codeScanning/deleteAnalysis.md @@ -8,10 +8,7 @@ type: API method # Delete a code scanning analysis from a repository -Deletes a specified code scanning analysis from a repository. For -private repositories, you must use an access token with the `repo` scope. For public repositories, -you must use an access token with `public_repo` scope. -GitHub Apps must have the `security_events` write permission to use this endpoint. +Deletes a specified code scanning analysis from a repository. You can delete one analysis at a time. To delete a series of analyses, start with the most recent analysis and work backwards. @@ -76,6 +73,8 @@ The procedure therefore consists of a nested loop: The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + ```js octokit.rest.codeScanning.deleteAnalysis({ owner, diff --git a/docs/codeScanning/getAlert.md b/docs/codeScanning/getAlert.md index 59570dffb..c9ec837c6 100644 --- a/docs/codeScanning/getAlert.md +++ b/docs/codeScanning/getAlert.md @@ -8,7 +8,9 @@ type: API method # Get a code scanning alert -Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. +Gets a single code scanning alert. + +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. ```js octokit.rest.codeScanning.getAlert({ diff --git a/docs/codeScanning/getAnalysis.md b/docs/codeScanning/getAnalysis.md index 81240cea9..4bbf747d3 100644 --- a/docs/codeScanning/getAnalysis.md +++ b/docs/codeScanning/getAnalysis.md @@ -9,9 +9,6 @@ type: API method # Get a code scanning analysis for a repository Gets a specified code scanning analysis for a repository. -You must use an access token with the `security_events` scope to use this endpoint with private repos, -the `public_repo` scope also grants permission to read security events on public repos only. -GitHub Apps must have the `security_events` read permission to use this endpoint. The default JSON response contains fields that describe the analysis. This includes the Git reference and commit SHA to which the analysis relates, @@ -23,10 +20,11 @@ that were run in the analysis. For very old analyses this data is not available, and `0` is returned in this field. -If you use the Accept header `application/sarif+json`, -the response contains the analysis data that was uploaded. -This is formatted as -[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). +This 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)." + +- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. ```js octokit.rest.codeScanning.getAnalysis({ diff --git a/docs/codeScanning/getCodeqlDatabase.md b/docs/codeScanning/getCodeqlDatabase.md index ad1d27153..19847fcc8 100644 --- a/docs/codeScanning/getCodeqlDatabase.md +++ b/docs/codeScanning/getCodeqlDatabase.md @@ -16,9 +16,7 @@ to [`application/zip`](https://docs.github.com/rest/overview/media-types), and m your HTTP client is configured to follow redirects or use the `Location` header to make a second request to get the redirect URL. -For private repositories, you must use an access token with the `security_events` scope. -For public repositories, you can use tokens with the `security_events` or `public_repo` scope. -GitHub Apps must have the `contents` read permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. ```js octokit.rest.codeScanning.getCodeqlDatabase({ diff --git a/docs/codeScanning/getDefaultSetup.md b/docs/codeScanning/getDefaultSetup.md index afb12ea3d..e7efda51c 100644 --- a/docs/codeScanning/getDefaultSetup.md +++ b/docs/codeScanning/getDefaultSetup.md @@ -9,8 +9,8 @@ type: API method # Get a code scanning default setup configuration Gets a code scanning default setup configuration. -You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` -scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. ```js octokit.rest.codeScanning.getDefaultSetup({ diff --git a/docs/codeScanning/getSarif.md b/docs/codeScanning/getSarif.md index 31bd66f7f..da43221c6 100644 --- a/docs/codeScanning/getSarif.md +++ b/docs/codeScanning/getSarif.md @@ -8,7 +8,8 @@ type: API method # Get information about a SARIF upload -Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. +Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. ```js octokit.rest.codeScanning.getSarif({ diff --git a/docs/codeScanning/listAlertInstances.md b/docs/codeScanning/listAlertInstances.md index 6f651daf3..53cd18490 100644 --- a/docs/codeScanning/listAlertInstances.md +++ b/docs/codeScanning/listAlertInstances.md @@ -9,9 +9,8 @@ type: API method # List instances of a code scanning alert Lists all instances of the specified code scanning alert. -You must use an access token with the `security_events` scope to use this endpoint with private repos, -the `public_repo` scope also grants permission to read security events on public repos only. -GitHub Apps must have the `security_events` read permission to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. ```js octokit.rest.codeScanning.listAlertInstances({ @@ -49,12 +48,12 @@ The number that identifies an alert. You can find this at the end of the URL for pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." refno diff --git a/docs/codeScanning/listAlertsForOrg.md b/docs/codeScanning/listAlertsForOrg.md index b34f47b74..fdda99ea8 100644 --- a/docs/codeScanning/listAlertsForOrg.md +++ b/docs/codeScanning/listAlertsForOrg.md @@ -10,11 +10,9 @@ type: API method Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." -To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. +The authenticated user must be an owner or security manager for the organization to use this endpoint. -For public repositories, you may instead use the `public_repo` scope. - -GitHub Apps must have the `security_events` read permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. ```js octokit.rest.codeScanning.listAlertsForOrg({ @@ -50,22 +48,22 @@ The GUID of a code scanning tool. Only results by this tool will be listed. Note beforeno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." afterno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." directionno diff --git a/docs/codeScanning/listAlertsInstances.md b/docs/codeScanning/listAlertsInstances.md index 77a8cf0a0..83abd45b6 100644 --- a/docs/codeScanning/listAlertsInstances.md +++ b/docs/codeScanning/listAlertsInstances.md @@ -11,9 +11,8 @@ type: API method **Deprecated:** This method has been renamed to codeScanning.listAlertInstances Lists all instances of the specified code scanning alert. -You must use an access token with the `security_events` scope to use this endpoint with private repos, -the `public_repo` scope also grants permission to read security events on public repos only. -GitHub Apps must have the `security_events` read permission to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. ```js octokit.rest.codeScanning.listAlertsInstances({ @@ -51,12 +50,12 @@ The number that identifies an alert. You can find this at the end of the URL for pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." refno diff --git a/docs/codeScanning/listCodeqlDatabases.md b/docs/codeScanning/listCodeqlDatabases.md index fcfb976d3..55a113d7f 100644 --- a/docs/codeScanning/listCodeqlDatabases.md +++ b/docs/codeScanning/listCodeqlDatabases.md @@ -10,9 +10,7 @@ type: API method Lists the CodeQL databases that are available in a repository. -For private repositories, you must use an access token with the `security_events` scope. -For public repositories, you can use tokens with the `security_events` or `public_repo` scope. -GitHub Apps must have the `contents` read permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. ```js octokit.rest.codeScanning.listCodeqlDatabases({ diff --git a/docs/codeScanning/listRecentAnalyses.md b/docs/codeScanning/listRecentAnalyses.md index 75a1350bd..de3d0cdaa 100644 --- a/docs/codeScanning/listRecentAnalyses.md +++ b/docs/codeScanning/listRecentAnalyses.md @@ -19,13 +19,11 @@ that were run in the analysis. For very old analyses this data is not available, and `0` is returned in this field. -You must use an access token with the `security_events` scope to use this endpoint with private repos, -the `public_repo` scope also grants permission to read security events on public repos only. -GitHub Apps must have the `security_events` read permission to use this endpoint. - **Deprecation notice**: The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + ```js octokit.rest.codeScanning.listRecentAnalyses({ owner, @@ -66,12 +64,12 @@ The GUID of a code scanning tool. Only results by this tool will be listed. Note pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." refno diff --git a/docs/codeScanning/updateAlert.md b/docs/codeScanning/updateAlert.md index 05e8d32d4..c7d3c1e37 100644 --- a/docs/codeScanning/updateAlert.md +++ b/docs/codeScanning/updateAlert.md @@ -8,7 +8,8 @@ type: API method # Update a code scanning alert -Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. +Updates the status of a single code scanning alert. +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. ```js octokit.rest.codeScanning.updateAlert({ diff --git a/docs/codeScanning/updateDefaultSetup.md b/docs/codeScanning/updateDefaultSetup.md index cd94ec368..14b3971fa 100644 --- a/docs/codeScanning/updateDefaultSetup.md +++ b/docs/codeScanning/updateDefaultSetup.md @@ -1,6 +1,6 @@ --- name: Update a code scanning default setup configuration -example: octokit.rest.codeScanning.updateDefaultSetup({ owner, repo, state }) +example: octokit.rest.codeScanning.updateDefaultSetup({ owner, repo }) route: PATCH /repos/{owner}/{repo}/code-scanning/default-setup scope: codeScanning type: API method @@ -9,14 +9,13 @@ type: API method # Update a code scanning default setup configuration Updates a code scanning default setup configuration. -You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` -scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. ```js octokit.rest.codeScanning.updateDefaultSetup({ owner, repo, - state, }); ``` @@ -41,9 +40,9 @@ 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. -stateyes +stateno -Whether code scanning default setup has been configured or not. +The desired state of code scanning default setup. query_suiteno diff --git a/docs/codeScanning/uploadSarif.md b/docs/codeScanning/uploadSarif.md index 7505d0c0e..355346ed5 100644 --- a/docs/codeScanning/uploadSarif.md +++ b/docs/codeScanning/uploadSarif.md @@ -8,7 +8,7 @@ type: API method # Upload an analysis as SARIF data -Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." +Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." There are two places where you can upload code scanning results. @@ -21,7 +21,6 @@ You must compress the SARIF-formatted analysis data that you want to upload, usi gzip -c analysis-data.sarif | base64 -w0 ``` -
SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." @@ -39,6 +38,8 @@ The `202 Accepted` response includes an `id` value. You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + ```js octokit.rest.codeScanning.uploadSarif({ owner, @@ -78,7 +79,7 @@ The SHA of the commit to which the analysis you are uploading relates. refyes The full Git reference, formatted as `refs/heads/`, -`refs/pull//merge`, or `refs/pull//head`. +`refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. sarifyes diff --git a/docs/codespaces/addRepositoryForSecretForAuthenticatedUser.md b/docs/codespaces/addRepositoryForSecretForAuthenticatedUser.md index b0ea74a77..2e5bc3e3b 100644 --- a/docs/codespaces/addRepositoryForSecretForAuthenticatedUser.md +++ b/docs/codespaces/addRepositoryForSecretForAuthenticatedUser.md @@ -8,9 +8,11 @@ type: API method # Add a selected repository to a user secret -Adds a repository to the selected repositories for a user's codespace secret. -You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. -GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. +Adds a repository to the selected repositories for a user's development environment secret. + +The authenticated user must have Codespaces access to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. ```js octokit.rest.codespaces.addRepositoryForSecretForAuthenticatedUser({ diff --git a/docs/codespaces/addSelectedRepoToOrgSecret.md b/docs/codespaces/addSelectedRepoToOrgSecret.md index 3beea7f5f..14c8ebb38 100644 --- a/docs/codespaces/addSelectedRepoToOrgSecret.md +++ b/docs/codespaces/addSelectedRepoToOrgSecret.md @@ -8,7 +8,8 @@ type: API method # Add selected repository to an organization secret -Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. +Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.addSelectedRepoToOrgSecret({ diff --git a/docs/codespaces/checkPermissionsForDevcontainer.md b/docs/codespaces/checkPermissionsForDevcontainer.md index acfd05092..bc3868031 100644 --- a/docs/codespaces/checkPermissionsForDevcontainer.md +++ b/docs/codespaces/checkPermissionsForDevcontainer.md @@ -10,9 +10,7 @@ type: API method Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.checkPermissionsForDevcontainer({ diff --git a/docs/codespaces/codespaceMachinesForAuthenticatedUser.md b/docs/codespaces/codespaceMachinesForAuthenticatedUser.md index 54849fac7..cd6a04f42 100644 --- a/docs/codespaces/codespaceMachinesForAuthenticatedUser.md +++ b/docs/codespaces/codespaceMachinesForAuthenticatedUser.md @@ -10,9 +10,7 @@ type: API method List the machine types a codespace can transition to use. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.codespaceMachinesForAuthenticatedUser({ diff --git a/docs/codespaces/createForAuthenticatedUser.md b/docs/codespaces/createForAuthenticatedUser.md index 66e360818..3d2024c69 100644 --- a/docs/codespaces/createForAuthenticatedUser.md +++ b/docs/codespaces/createForAuthenticatedUser.md @@ -12,9 +12,7 @@ Creates a new codespace, owned by the authenticated user. This endpoint requires either a `repository_id` OR a `pull_request` but not both. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.createForAuthenticatedUser({ diff --git a/docs/codespaces/createOrUpdateOrgSecret.md b/docs/codespaces/createOrUpdateOrgSecret.md index f011e7c94..46b693648 100644 --- a/docs/codespaces/createOrUpdateOrgSecret.md +++ b/docs/codespaces/createOrUpdateOrgSecret.md @@ -8,11 +8,10 @@ type: API method # Create or update an organization secret -Creates or updates an organization secret with an encrypted value. Encrypt your secret using +Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." -You must authenticate using an access -token with the `admin:org` scope to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.createOrUpdateOrgSecret({ diff --git a/docs/codespaces/createOrUpdateRepoSecret.md b/docs/codespaces/createOrUpdateRepoSecret.md index 51c53d3bb..565fa0693 100644 --- a/docs/codespaces/createOrUpdateRepoSecret.md +++ b/docs/codespaces/createOrUpdateRepoSecret.md @@ -8,12 +8,10 @@ type: API method # Create or update a repository secret -Creates or updates a repository secret with an encrypted value. Encrypt your secret using +Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." -You must authenticate using an access -token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` -repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.codespaces.createOrUpdateRepoSecret({ diff --git a/docs/codespaces/createOrUpdateSecretForAuthenticatedUser.md b/docs/codespaces/createOrUpdateSecretForAuthenticatedUser.md index da58b3c91..c007292e5 100644 --- a/docs/codespaces/createOrUpdateSecretForAuthenticatedUser.md +++ b/docs/codespaces/createOrUpdateSecretForAuthenticatedUser.md @@ -8,12 +8,12 @@ type: API method # Create or update a secret for the authenticated user -Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using +Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." -You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. +The authenticated user must have Codespaces access to use this endpoint. -GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. ```js octokit.rest.codespaces.createOrUpdateSecretForAuthenticatedUser({ diff --git a/docs/codespaces/createWithPrForAuthenticatedUser.md b/docs/codespaces/createWithPrForAuthenticatedUser.md index c3319cc70..d6cd75478 100644 --- a/docs/codespaces/createWithPrForAuthenticatedUser.md +++ b/docs/codespaces/createWithPrForAuthenticatedUser.md @@ -10,9 +10,7 @@ type: API method Creates a codespace owned by the authenticated user for the specified pull request. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.createWithPrForAuthenticatedUser({ diff --git a/docs/codespaces/createWithRepoForAuthenticatedUser.md b/docs/codespaces/createWithRepoForAuthenticatedUser.md index fc629371b..1233206e6 100644 --- a/docs/codespaces/createWithRepoForAuthenticatedUser.md +++ b/docs/codespaces/createWithRepoForAuthenticatedUser.md @@ -10,9 +10,7 @@ type: API method Creates a codespace owned by the authenticated user in the specified repository. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.createWithRepoForAuthenticatedUser({ diff --git a/docs/codespaces/deleteForAuthenticatedUser.md b/docs/codespaces/deleteForAuthenticatedUser.md index fb1b5846a..1f735effd 100644 --- a/docs/codespaces/deleteForAuthenticatedUser.md +++ b/docs/codespaces/deleteForAuthenticatedUser.md @@ -10,9 +10,7 @@ type: API method Deletes a user's codespace. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.deleteForAuthenticatedUser({ diff --git a/docs/codespaces/deleteFromOrganization.md b/docs/codespaces/deleteFromOrganization.md index 526e81eee..d0b157d79 100644 --- a/docs/codespaces/deleteFromOrganization.md +++ b/docs/codespaces/deleteFromOrganization.md @@ -10,10 +10,7 @@ type: API method Deletes a user's codespace. -To use this endpoint you must authenticate using one of the following methods: - -- An access token with the `admin:org` scope -- An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.deleteFromOrganization({ diff --git a/docs/codespaces/deleteOrgSecret.md b/docs/codespaces/deleteOrgSecret.md index caeed6c81..5d7acbfb1 100644 --- a/docs/codespaces/deleteOrgSecret.md +++ b/docs/codespaces/deleteOrgSecret.md @@ -8,7 +8,9 @@ type: API method # Delete an organization secret -Deletes an organization secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +Deletes an organization development environment secret using the secret name. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.deleteOrgSecret({ diff --git a/docs/codespaces/deleteRepoSecret.md b/docs/codespaces/deleteRepoSecret.md index 96f60ca4b..e9fb151d6 100644 --- a/docs/codespaces/deleteRepoSecret.md +++ b/docs/codespaces/deleteRepoSecret.md @@ -8,7 +8,9 @@ type: API method # Delete a repository secret -Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. +Deletes a development environment secret in a repository using the secret name. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.codespaces.deleteRepoSecret({ diff --git a/docs/codespaces/deleteSecretForAuthenticatedUser.md b/docs/codespaces/deleteSecretForAuthenticatedUser.md index 64b8820a5..9dd2dc743 100644 --- a/docs/codespaces/deleteSecretForAuthenticatedUser.md +++ b/docs/codespaces/deleteSecretForAuthenticatedUser.md @@ -8,11 +8,11 @@ type: API method # Delete a secret for the authenticated user -Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. +Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. -You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. +The authenticated user must have Codespaces access to use this endpoint. -GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. ```js octokit.rest.codespaces.deleteSecretForAuthenticatedUser({ diff --git a/docs/codespaces/exportForAuthenticatedUser.md b/docs/codespaces/exportForAuthenticatedUser.md index 5854c0ab1..374a92db2 100644 --- a/docs/codespaces/exportForAuthenticatedUser.md +++ b/docs/codespaces/exportForAuthenticatedUser.md @@ -12,9 +12,7 @@ Triggers an export of the specified codespace and returns a URL and ID where the If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. -You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.exportForAuthenticatedUser({ diff --git a/docs/codespaces/getCodespacesForUserInOrg.md b/docs/codespaces/getCodespacesForUserInOrg.md index 9feb3bc89..85dd1531a 100644 --- a/docs/codespaces/getCodespacesForUserInOrg.md +++ b/docs/codespaces/getCodespacesForUserInOrg.md @@ -10,7 +10,7 @@ type: API method Lists the codespaces that a member of an organization has for repositories in that organization. -You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.getCodespacesForUserInOrg({ @@ -32,12 +32,12 @@ octokit.rest.codespaces.getCodespacesForUserInOrg({ per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." orgyes diff --git a/docs/codespaces/getExportDetailsForAuthenticatedUser.md b/docs/codespaces/getExportDetailsForAuthenticatedUser.md index 359ca9acc..e85032607 100644 --- a/docs/codespaces/getExportDetailsForAuthenticatedUser.md +++ b/docs/codespaces/getExportDetailsForAuthenticatedUser.md @@ -10,9 +10,7 @@ type: API method Gets information about an export of a codespace. -You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.getExportDetailsForAuthenticatedUser({ diff --git a/docs/codespaces/getForAuthenticatedUser.md b/docs/codespaces/getForAuthenticatedUser.md index a0c302cea..fd03703c5 100644 --- a/docs/codespaces/getForAuthenticatedUser.md +++ b/docs/codespaces/getForAuthenticatedUser.md @@ -10,9 +10,7 @@ type: API method Gets information about a user's codespace. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.getForAuthenticatedUser({ diff --git a/docs/codespaces/getOrgPublicKey.md b/docs/codespaces/getOrgPublicKey.md index 65e0c9e9c..0afb36132 100644 --- a/docs/codespaces/getOrgPublicKey.md +++ b/docs/codespaces/getOrgPublicKey.md @@ -8,7 +8,8 @@ type: API method # Get an organization public key -Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.getOrgPublicKey({ diff --git a/docs/codespaces/getOrgSecret.md b/docs/codespaces/getOrgSecret.md index abb41d101..6be0dec2c 100644 --- a/docs/codespaces/getOrgSecret.md +++ b/docs/codespaces/getOrgSecret.md @@ -8,8 +8,9 @@ type: API method # Get an organization secret -Gets an organization secret without revealing its encrypted value. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. +Gets an organization development environment secret without revealing its encrypted value. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.getOrgSecret({ diff --git a/docs/codespaces/getPublicKeyForAuthenticatedUser.md b/docs/codespaces/getPublicKeyForAuthenticatedUser.md index b158ce678..05e33ca95 100644 --- a/docs/codespaces/getPublicKeyForAuthenticatedUser.md +++ b/docs/codespaces/getPublicKeyForAuthenticatedUser.md @@ -10,9 +10,9 @@ type: API method Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. -You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. +The authenticated user must have Codespaces access to use this endpoint. -GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. ```js octokit.rest.codespaces.getPublicKeyForAuthenticatedUser(); diff --git a/docs/codespaces/getRepoPublicKey.md b/docs/codespaces/getRepoPublicKey.md index 12f5d2298..ef98f0a21 100644 --- a/docs/codespaces/getRepoPublicKey.md +++ b/docs/codespaces/getRepoPublicKey.md @@ -8,7 +8,12 @@ type: API method # Get a repository public key -Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. +Gets your public key, which you need to encrypt secrets. You need to +encrypt a secret before you can create or update secrets. + +Anyone with read access to the repository can use this endpoint. + +If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.codespaces.getRepoPublicKey({ diff --git a/docs/codespaces/getRepoSecret.md b/docs/codespaces/getRepoSecret.md index 74ad36f3d..b5b9c809f 100644 --- a/docs/codespaces/getRepoSecret.md +++ b/docs/codespaces/getRepoSecret.md @@ -8,7 +8,9 @@ type: API method # Get a repository secret -Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. +Gets a single repository development environment secret without revealing its encrypted value. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.codespaces.getRepoSecret({ diff --git a/docs/codespaces/getSecretForAuthenticatedUser.md b/docs/codespaces/getSecretForAuthenticatedUser.md index 1e178cc1a..10ed23fb2 100644 --- a/docs/codespaces/getSecretForAuthenticatedUser.md +++ b/docs/codespaces/getSecretForAuthenticatedUser.md @@ -8,11 +8,11 @@ type: API method # Get a secret for the authenticated user -Gets a secret available to a user's codespaces without revealing its encrypted value. +Gets a development environment secret available to a user's codespaces without revealing its encrypted value. -You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. +The authenticated user must have Codespaces access to use this endpoint. -GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. ```js octokit.rest.codespaces.getSecretForAuthenticatedUser({ diff --git a/docs/codespaces/listDevcontainersInRepositoryForAuthenticatedUser.md b/docs/codespaces/listDevcontainersInRepositoryForAuthenticatedUser.md index b44781903..856a4903d 100644 --- a/docs/codespaces/listDevcontainersInRepositoryForAuthenticatedUser.md +++ b/docs/codespaces/listDevcontainersInRepositoryForAuthenticatedUser.md @@ -11,9 +11,7 @@ type: API method Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files specify launchpoint configurations for codespaces created within the repository. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.listDevcontainersInRepositoryForAuthenticatedUser({ @@ -35,12 +33,12 @@ octokit.rest.codespaces.listDevcontainersInRepositoryForAuthenticatedUser({ per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." owneryes diff --git a/docs/codespaces/listForAuthenticatedUser.md b/docs/codespaces/listForAuthenticatedUser.md index 95013b7ba..926eb4342 100644 --- a/docs/codespaces/listForAuthenticatedUser.md +++ b/docs/codespaces/listForAuthenticatedUser.md @@ -10,9 +10,7 @@ type: API method Lists the authenticated user's codespaces. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.listForAuthenticatedUser(); @@ -31,12 +29,12 @@ octokit.rest.codespaces.listForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." repository_idno diff --git a/docs/codespaces/listInOrganization.md b/docs/codespaces/listInOrganization.md index d4ec91c16..6824e7f63 100644 --- a/docs/codespaces/listInOrganization.md +++ b/docs/codespaces/listInOrganization.md @@ -10,7 +10,7 @@ type: API method Lists the codespaces associated to a specified organization. -You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.listInOrganization({ @@ -31,12 +31,12 @@ octokit.rest.codespaces.listInOrganization({ per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." orgyes diff --git a/docs/codespaces/listInRepositoryForAuthenticatedUser.md b/docs/codespaces/listInRepositoryForAuthenticatedUser.md index fa821b61b..556a29629 100644 --- a/docs/codespaces/listInRepositoryForAuthenticatedUser.md +++ b/docs/codespaces/listInRepositoryForAuthenticatedUser.md @@ -10,9 +10,7 @@ type: API method Lists the codespaces associated to a specified repository and the authenticated user. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.listInRepositoryForAuthenticatedUser({ @@ -34,12 +32,12 @@ octokit.rest.codespaces.listInRepositoryForAuthenticatedUser({ per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." owneryes diff --git a/docs/codespaces/listOrgSecrets.md b/docs/codespaces/listOrgSecrets.md index b827fdae9..efba4a54d 100644 --- a/docs/codespaces/listOrgSecrets.md +++ b/docs/codespaces/listOrgSecrets.md @@ -8,8 +8,10 @@ type: API method # List organization secrets -Lists all Codespaces secrets available at the organization-level without revealing their encrypted values. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. +Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted +values. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.listOrgSecrets({ @@ -35,12 +37,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/codespaces/listRepoSecrets.md b/docs/codespaces/listRepoSecrets.md index 28ca43918..72d6ca022 100644 --- a/docs/codespaces/listRepoSecrets.md +++ b/docs/codespaces/listRepoSecrets.md @@ -8,7 +8,10 @@ type: API method # List repository secrets -Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. +Lists all development environment secrets available in a repository without revealing their encrypted +values. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.codespaces.listRepoSecrets({ @@ -40,12 +43,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/codespaces/listRepositoriesForSecretForAuthenticatedUser.md b/docs/codespaces/listRepositoriesForSecretForAuthenticatedUser.md index abf8cdf1c..fbdd3fec1 100644 --- a/docs/codespaces/listRepositoriesForSecretForAuthenticatedUser.md +++ b/docs/codespaces/listRepositoriesForSecretForAuthenticatedUser.md @@ -8,11 +8,11 @@ type: API method # List selected repositories for a user secret -List the repositories that have been granted the ability to use a user's codespace secret. +List the repositories that have been granted the ability to use a user's development environment secret. -You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. +The authenticated user must have Codespaces access to use this endpoint. -GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. ```js octokit.rest.codespaces.listRepositoriesForSecretForAuthenticatedUser({ diff --git a/docs/codespaces/listSecretsForAuthenticatedUser.md b/docs/codespaces/listSecretsForAuthenticatedUser.md index 9d6055d80..597f205a5 100644 --- a/docs/codespaces/listSecretsForAuthenticatedUser.md +++ b/docs/codespaces/listSecretsForAuthenticatedUser.md @@ -8,12 +8,12 @@ type: API method # List secrets for the authenticated user -Lists all secrets available for a user's Codespaces without revealing their +Lists all development environment secrets available for a user's codespaces without revealing their encrypted values. -You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. +The authenticated user must have Codespaces access to use this endpoint. -GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. ```js octokit.rest.codespaces.listSecretsForAuthenticatedUser(); @@ -32,12 +32,12 @@ octokit.rest.codespaces.listSecretsForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/codespaces/listSelectedReposForOrgSecret.md b/docs/codespaces/listSelectedReposForOrgSecret.md index af960bb53..abb6c4e8c 100644 --- a/docs/codespaces/listSelectedReposForOrgSecret.md +++ b/docs/codespaces/listSelectedReposForOrgSecret.md @@ -8,7 +8,10 @@ type: API method # List selected repositories for an organization secret -Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +Lists all repositories that have been selected when the `visibility` +for repository access to a secret is set to `selected`. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.listSelectedReposForOrgSecret({ @@ -40,12 +43,12 @@ The name of the secret. pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/codespaces/preFlightWithRepoForAuthenticatedUser.md b/docs/codespaces/preFlightWithRepoForAuthenticatedUser.md index fb45c6e60..5111fbda6 100644 --- a/docs/codespaces/preFlightWithRepoForAuthenticatedUser.md +++ b/docs/codespaces/preFlightWithRepoForAuthenticatedUser.md @@ -10,9 +10,7 @@ type: API method Gets the default attributes for codespaces created by the user with the repository. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.preFlightWithRepoForAuthenticatedUser({ diff --git a/docs/codespaces/publishForAuthenticatedUser.md b/docs/codespaces/publishForAuthenticatedUser.md index 697a9cf1d..31cbdfe0d 100644 --- a/docs/codespaces/publishForAuthenticatedUser.md +++ b/docs/codespaces/publishForAuthenticatedUser.md @@ -14,9 +14,7 @@ The codespace's token is granted write permissions to the repository, allowing t This will fail for a codespace that is already published, meaning it has an associated repository. -You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.publishForAuthenticatedUser({ diff --git a/docs/codespaces/removeRepositoryForSecretForAuthenticatedUser.md b/docs/codespaces/removeRepositoryForSecretForAuthenticatedUser.md index a1402ea17..e04429e99 100644 --- a/docs/codespaces/removeRepositoryForSecretForAuthenticatedUser.md +++ b/docs/codespaces/removeRepositoryForSecretForAuthenticatedUser.md @@ -8,9 +8,11 @@ type: API method # Remove a selected repository from a user secret -Removes a repository from the selected repositories for a user's codespace secret. -You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. -GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. +Removes a repository from the selected repositories for a user's development environment secret. + +The authenticated user must have Codespaces access to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. ```js octokit.rest.codespaces.removeRepositoryForSecretForAuthenticatedUser({ diff --git a/docs/codespaces/removeSelectedRepoFromOrgSecret.md b/docs/codespaces/removeSelectedRepoFromOrgSecret.md index ee67edfe1..74997ff11 100644 --- a/docs/codespaces/removeSelectedRepoFromOrgSecret.md +++ b/docs/codespaces/removeSelectedRepoFromOrgSecret.md @@ -8,7 +8,11 @@ type: API method # Remove selected repository from an organization secret -Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. +Removes a repository from an organization development environment secret when the `visibility` +for repository access is set to `selected`. The visibility is set when you [Create +or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.removeSelectedRepoFromOrgSecret({ diff --git a/docs/codespaces/repoMachinesForAuthenticatedUser.md b/docs/codespaces/repoMachinesForAuthenticatedUser.md index 5a2646d4e..6c08b1f5f 100644 --- a/docs/codespaces/repoMachinesForAuthenticatedUser.md +++ b/docs/codespaces/repoMachinesForAuthenticatedUser.md @@ -10,9 +10,7 @@ type: API method List the machine types available for a given repository based on its configuration. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.repoMachinesForAuthenticatedUser({ diff --git a/docs/codespaces/setRepositoriesForSecretForAuthenticatedUser.md b/docs/codespaces/setRepositoriesForSecretForAuthenticatedUser.md index 5024f2743..49a20c3f3 100644 --- a/docs/codespaces/setRepositoriesForSecretForAuthenticatedUser.md +++ b/docs/codespaces/setRepositoriesForSecretForAuthenticatedUser.md @@ -8,11 +8,11 @@ type: API method # Set selected repositories for a user secret -Select the repositories that will use a user's codespace secret. +Select the repositories that will use a user's development environment secret. -You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. +The authenticated user must have Codespaces access to use this endpoint. -GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. ```js octokit.rest.codespaces.setRepositoriesForSecretForAuthenticatedUser({ diff --git a/docs/codespaces/setSelectedReposForOrgSecret.md b/docs/codespaces/setSelectedReposForOrgSecret.md index 1be3fedf1..90744a7a0 100644 --- a/docs/codespaces/setSelectedReposForOrgSecret.md +++ b/docs/codespaces/setSelectedReposForOrgSecret.md @@ -8,7 +8,11 @@ type: API method # Set selected repositories for an organization secret -Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. +Replaces all repositories for an organization development environment secret when the `visibility` +for repository access is set to `selected`. The visibility is set when you [Create +or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.setSelectedReposForOrgSecret({ diff --git a/docs/codespaces/startForAuthenticatedUser.md b/docs/codespaces/startForAuthenticatedUser.md index 4f05e4c49..10fd847ed 100644 --- a/docs/codespaces/startForAuthenticatedUser.md +++ b/docs/codespaces/startForAuthenticatedUser.md @@ -10,9 +10,7 @@ type: API method Starts a user's codespace. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.startForAuthenticatedUser({ diff --git a/docs/codespaces/stopForAuthenticatedUser.md b/docs/codespaces/stopForAuthenticatedUser.md index edcb59665..8f6f1eda6 100644 --- a/docs/codespaces/stopForAuthenticatedUser.md +++ b/docs/codespaces/stopForAuthenticatedUser.md @@ -10,9 +10,7 @@ type: API method Stops a user's codespace. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.stopForAuthenticatedUser({ diff --git a/docs/codespaces/stopInOrganization.md b/docs/codespaces/stopInOrganization.md index 352b7d4a2..4657ea2b3 100644 --- a/docs/codespaces/stopInOrganization.md +++ b/docs/codespaces/stopInOrganization.md @@ -10,10 +10,7 @@ type: API method Stops a user's codespace. -To use this endpoint you must authenticate using one of the following methods: - -- An access token with the `admin:org` scope -- An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.stopInOrganization({ diff --git a/docs/codespaces/updateForAuthenticatedUser.md b/docs/codespaces/updateForAuthenticatedUser.md index 803a30082..7b08113f1 100644 --- a/docs/codespaces/updateForAuthenticatedUser.md +++ b/docs/codespaces/updateForAuthenticatedUser.md @@ -12,9 +12,7 @@ Updates a codespace owned by the authenticated user. Currently only the codespac If you specify a new machine type it will be applied the next time your codespace is started. -You must authenticate using an access token with the `codespace` scope to use this endpoint. - -GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. ```js octokit.rest.codespaces.updateForAuthenticatedUser({ diff --git a/docs/copilot/addCopilotSeatsForTeams.md b/docs/copilot/addCopilotSeatsForTeams.md new file mode 100644 index 000000000..2155c3c98 --- /dev/null +++ b/docs/copilot/addCopilotSeatsForTeams.md @@ -0,0 +1,55 @@ +--- +name: Add teams to the Copilot subscription for an organization +example: octokit.rest.copilot.addCopilotSeatsForTeams({ org, selected_teams }) +route: POST /orgs/{org}/copilot/billing/selected_teams +scope: copilot +type: API method +--- + +# Add teams to the Copilot subscription for an organization + +**Note**: This endpoint is in beta and is subject to change. + +Purchases a GitHub Copilot seat for all users within each specified team. +The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + +Only organization owners can configure GitHub Copilot in their organization. + +In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. +For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". +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/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + +OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + +```js +octokit.rest.copilot.addCopilotSeatsForTeams({ + 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-user-management#add-teams-to-the-copilot-subscription-for-an-organization). diff --git a/docs/copilot/addCopilotSeatsForUsers.md b/docs/copilot/addCopilotSeatsForUsers.md new file mode 100644 index 000000000..df6cff4b2 --- /dev/null +++ b/docs/copilot/addCopilotSeatsForUsers.md @@ -0,0 +1,55 @@ +--- +name: Add users to the Copilot subscription for an organization +example: octokit.rest.copilot.addCopilotSeatsForUsers({ org, selected_usernames }) +route: POST /orgs/{org}/copilot/billing/selected_users +scope: copilot +type: API method +--- + +# Add users to the Copilot subscription for an organization + +**Note**: This endpoint is in beta and is subject to change. + +Purchases a GitHub Copilot seat for each user specified. +The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + +Only organization owners can configure GitHub Copilot in their organization. + +In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. +For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". +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/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + +OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + +```js +octokit.rest.copilot.addCopilotSeatsForUsers({ + 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-user-management#add-users-to-the-copilot-subscription-for-an-organization). diff --git a/docs/copilot/cancelCopilotSeatAssignmentForTeams.md b/docs/copilot/cancelCopilotSeatAssignmentForTeams.md index 80c208606..748c78a51 100644 --- a/docs/copilot/cancelCopilotSeatAssignmentForTeams.md +++ b/docs/copilot/cancelCopilotSeatAssignmentForTeams.md @@ -1,24 +1,25 @@ --- -name: Remove teams from the Copilot for Business subscription for an organization +name: Remove teams from the Copilot subscription for an organization example: octokit.rest.copilot.cancelCopilotSeatAssignmentForTeams({ org, selected_teams }) route: DELETE /orgs/{org}/copilot/billing/selected_teams scope: copilot type: API method --- -# Remove teams from the Copilot for Business subscription for an organization +# Remove teams from the Copilot subscription for an organization **Note**: This endpoint is in beta and is subject to change. -Cancels the Copilot for Business seat assignment for all members of each team specified. +Cancels the Copilot seat assignment for all members of each team specified. This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. -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)". +For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". -For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". +For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". -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. +Only organization owners can configure GitHub Copilot in their organization. + +OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. ```js octokit.rest.copilot.cancelCopilotSeatAssignmentForTeams({ @@ -51,4 +52,4 @@ The names of teams from which to revoke access to GitHub Copilot. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#remove-teams-from-the-copilot-for-business-subscription-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization). diff --git a/docs/copilot/cancelCopilotSeatAssignmentForUsers.md b/docs/copilot/cancelCopilotSeatAssignmentForUsers.md index fa631b458..fd0b89383 100644 --- a/docs/copilot/cancelCopilotSeatAssignmentForUsers.md +++ b/docs/copilot/cancelCopilotSeatAssignmentForUsers.md @@ -1,24 +1,25 @@ --- -name: Remove users from the Copilot for Business subscription for an organization +name: Remove users from the Copilot subscription for an organization example: octokit.rest.copilot.cancelCopilotSeatAssignmentForUsers({ org, selected_usernames }) route: DELETE /orgs/{org}/copilot/billing/selected_users scope: copilot type: API method --- -# Remove users from the Copilot for Business subscription for an organization +# Remove users from the Copilot subscription for an organization **Note**: This endpoint is in beta and is subject to change. -Cancels the Copilot for Business seat assignment for each user specified. +Cancels the Copilot seat assignment for each user specified. This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. -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)" +For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". -For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". +For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". -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. +Only organization owners can configure GitHub Copilot in their organization. + +OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. ```js octokit.rest.copilot.cancelCopilotSeatAssignmentForUsers({ @@ -51,4 +52,4 @@ The usernames of the organization members for which to revoke access to GitHub C -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#remove-users-from-the-copilot-for-business-subscription-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization). diff --git a/docs/copilot/getCopilotOrganizationDetails.md b/docs/copilot/getCopilotOrganizationDetails.md index 8c506b07a..944d9eb62 100644 --- a/docs/copilot/getCopilotOrganizationDetails.md +++ b/docs/copilot/getCopilotOrganizationDetails.md @@ -1,21 +1,22 @@ --- -name: Get Copilot for Business seat information and settings for an organization +name: Get Copilot seat information and settings for an organization example: octokit.rest.copilot.getCopilotOrganizationDetails({ org }) route: GET /orgs/{org}/copilot/billing scope: copilot type: API method --- -# Get Copilot for Business seat information and settings for an organization +# Get Copilot seat information and settings for an organization **Note**: This endpoint is in beta and is subject to change. -Gets information about an organization's Copilot for Business subscription, including seat breakdown +Gets information about an organization's Copilot subscription, including seat breakdown and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. -For more information, see "[Configuring GitHub Copilot settings in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)". +For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". -Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must -authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. +Only organization owners can configure and view details about the organization's Copilot Business subscription. + +OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. ```js octokit.rest.copilot.getCopilotOrganizationDetails({ @@ -42,4 +43,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-information-and-settings-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization). diff --git a/docs/copilot/getCopilotSeatDetailsForUser.md b/docs/copilot/getCopilotSeatDetailsForUser.md index 1b42d5ac7..9af718c98 100644 --- a/docs/copilot/getCopilotSeatDetailsForUser.md +++ b/docs/copilot/getCopilotSeatDetailsForUser.md @@ -1,18 +1,20 @@ --- -name: Get Copilot for Business seat assignment details for a user +name: Get Copilot seat assignment details for a user example: octokit.rest.copilot.getCopilotSeatDetailsForUser({ org, username }) route: GET /orgs/{org}/members/{username}/copilot scope: copilot type: API method --- -# Get Copilot for Business seat assignment details for a user +# Get Copilot seat assignment details for a user **Note**: This endpoint is in beta and is subject to change. -Gets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. +Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. -Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. +Organization owners can view GitHub Copilot seat assignment details for members in their organization. + +OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. ```js octokit.rest.copilot.getCopilotSeatDetailsForUser({ @@ -45,4 +47,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-assignment-details-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user). diff --git a/docs/copilot/listCopilotSeats.md b/docs/copilot/listCopilotSeats.md index e7415cce0..af3851a9c 100644 --- a/docs/copilot/listCopilotSeats.md +++ b/docs/copilot/listCopilotSeats.md @@ -1,19 +1,20 @@ --- -name: List all Copilot for Business seat assignments for an organization +name: List all Copilot seat assignments for an organization example: octokit.rest.copilot.listCopilotSeats({ org }) route: GET /orgs/{org}/copilot/billing/seats scope: copilot type: API method --- -# List all Copilot for Business seat assignments for an organization +# List all Copilot seat assignments for an organization **Note**: This endpoint is in beta and is subject to change. -Lists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). +Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). -Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must -authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. +Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + +OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. ```js octokit.rest.copilot.listCopilotSeats({ @@ -39,15 +40,15 @@ The organization name. The name is not case sensitive. pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#list-all-copilot-for-business-seat-assignments-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization). diff --git a/docs/dependabot/addSelectedRepoToOrgSecret.md b/docs/dependabot/addSelectedRepoToOrgSecret.md index 4a2d57255..12496ab38 100644 --- a/docs/dependabot/addSelectedRepoToOrgSecret.md +++ b/docs/dependabot/addSelectedRepoToOrgSecret.md @@ -8,7 +8,11 @@ type: API method # Add selected repository to an organization secret -Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. +Adds a repository to an organization secret when the `visibility` for +repository access is set to `selected`. The visibility is set when you [Create or +update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.dependabot.addSelectedRepoToOrgSecret({ diff --git a/docs/dependabot/createOrUpdateRepoSecret.md b/docs/dependabot/createOrUpdateRepoSecret.md index 22440aa97..fe86f713a 100644 --- a/docs/dependabot/createOrUpdateRepoSecret.md +++ b/docs/dependabot/createOrUpdateRepoSecret.md @@ -11,9 +11,7 @@ type: API method Creates or updates a repository secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." -You must authenticate using an access -token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository -permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.dependabot.createOrUpdateRepoSecret({ diff --git a/docs/dependabot/deleteOrgSecret.md b/docs/dependabot/deleteOrgSecret.md index 50681a0d2..ea8746cdc 100644 --- a/docs/dependabot/deleteOrgSecret.md +++ b/docs/dependabot/deleteOrgSecret.md @@ -8,7 +8,9 @@ type: API method # Delete an organization secret -Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. +Deletes a secret in an organization using the secret name. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.dependabot.deleteOrgSecret({ diff --git a/docs/dependabot/deleteRepoSecret.md b/docs/dependabot/deleteRepoSecret.md index a7f2a4bb9..51cc5d21d 100644 --- a/docs/dependabot/deleteRepoSecret.md +++ b/docs/dependabot/deleteRepoSecret.md @@ -8,7 +8,9 @@ type: API method # Delete a repository secret -Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. +Deletes a secret in a repository using the secret name. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.dependabot.deleteRepoSecret({ diff --git a/docs/dependabot/getAlert.md b/docs/dependabot/getAlert.md index 08dec3da5..adbff4562 100644 --- a/docs/dependabot/getAlert.md +++ b/docs/dependabot/getAlert.md @@ -8,9 +8,7 @@ type: API method # Get a Dependabot alert -You must use an access token with the `security_events` scope to use this endpoint with private repositories. -You can also use tokens with the `public_repo` scope for public repositories only. -GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. ```js octokit.rest.dependabot.getAlert({ diff --git a/docs/dependabot/getOrgPublicKey.md b/docs/dependabot/getOrgPublicKey.md index 6784e7f62..22c01bace 100644 --- a/docs/dependabot/getOrgPublicKey.md +++ b/docs/dependabot/getOrgPublicKey.md @@ -8,7 +8,10 @@ type: API method # Get an organization public key -Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. +Gets your public key, which you need to encrypt secrets. You need to +encrypt a secret before you can create or update secrets. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.dependabot.getOrgPublicKey({ diff --git a/docs/dependabot/getOrgSecret.md b/docs/dependabot/getOrgSecret.md index 37f85421a..bc0cca566 100644 --- a/docs/dependabot/getOrgSecret.md +++ b/docs/dependabot/getOrgSecret.md @@ -8,7 +8,9 @@ type: API method # Get an organization secret -Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. +Gets a single organization secret without revealing its encrypted value. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.dependabot.getOrgSecret({ diff --git a/docs/dependabot/getRepoPublicKey.md b/docs/dependabot/getRepoPublicKey.md index b0a09368c..2c785d6a7 100644 --- a/docs/dependabot/getRepoPublicKey.md +++ b/docs/dependabot/getRepoPublicKey.md @@ -8,7 +8,11 @@ type: API method # Get a repository public key -Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. +Gets your public key, which you need to encrypt secrets. You need to +encrypt a secret before you can create or update secrets. Anyone with read access +to the repository can use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. ```js octokit.rest.dependabot.getRepoPublicKey({ diff --git a/docs/dependabot/getRepoSecret.md b/docs/dependabot/getRepoSecret.md index 4102bee77..b85c01b6e 100644 --- a/docs/dependabot/getRepoSecret.md +++ b/docs/dependabot/getRepoSecret.md @@ -8,7 +8,9 @@ type: API method # Get a repository secret -Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. +Gets a single repository secret without revealing its encrypted value. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.dependabot.getRepoSecret({ diff --git a/docs/dependabot/listAlertsForEnterprise.md b/docs/dependabot/listAlertsForEnterprise.md index 8e62d869c..4586be359 100644 --- a/docs/dependabot/listAlertsForEnterprise.md +++ b/docs/dependabot/listAlertsForEnterprise.md @@ -9,10 +9,13 @@ type: API method # List Dependabot alerts for an enterprise Lists Dependabot alerts for repositories that are owned by the specified enterprise. -To use this endpoint, you must be a member of the enterprise, and you must use an -access token with the `repo` scope or `security_events` scope. + +The authenticated user must be a member of the enterprise to use this endpoint. + Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." +OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + ```js octokit.rest.dependabot.listAlertsForEnterprise({ enterprise, @@ -80,12 +83,12 @@ The direction to sort the results by. beforeno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." afterno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." firstno @@ -104,7 +107,7 @@ Instead, use `per_page` in combination with `before` to fetch the last page of r per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/dependabot/listAlertsForOrg.md b/docs/dependabot/listAlertsForOrg.md index a904c5239..6a9769d80 100644 --- a/docs/dependabot/listAlertsForOrg.md +++ b/docs/dependabot/listAlertsForOrg.md @@ -10,11 +10,9 @@ type: API method Lists Dependabot alerts for an organization. -To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. +The authenticated user must be an owner or security manager for the organization to use this endpoint. -For public repositories, you may instead use the `public_repo` scope. - -GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. ```js octokit.rest.dependabot.listAlertsForOrg({ @@ -83,12 +81,12 @@ The direction to sort the results by. beforeno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." afterno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." firstno @@ -107,7 +105,7 @@ Instead, use `per_page` in combination with `before` to fetch the last page of r per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/dependabot/listAlertsForRepo.md b/docs/dependabot/listAlertsForRepo.md index d0a4e74e4..a9c0ddb8c 100644 --- a/docs/dependabot/listAlertsForRepo.md +++ b/docs/dependabot/listAlertsForRepo.md @@ -8,9 +8,7 @@ type: API method # List Dependabot alerts for a repository -You must use an access token with the `security_events` scope to use this endpoint with private repositories. -You can also use tokens with the `public_repo` scope for public repositories only. -GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. ```js octokit.rest.dependabot.listAlertsForRepo({ @@ -95,17 +93,17 @@ The direction to sort the results by. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." beforeno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." afterno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." firstno diff --git a/docs/dependabot/listOrgSecrets.md b/docs/dependabot/listOrgSecrets.md index c3d97fe60..3f239115a 100644 --- a/docs/dependabot/listOrgSecrets.md +++ b/docs/dependabot/listOrgSecrets.md @@ -8,7 +8,10 @@ type: API method # List organization secrets -Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. +Lists all secrets available in an organization without revealing their +encrypted values. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.dependabot.listOrgSecrets({ @@ -34,12 +37,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/dependabot/listRepoSecrets.md b/docs/dependabot/listRepoSecrets.md index 15db5d7ed..b78188a7a 100644 --- a/docs/dependabot/listRepoSecrets.md +++ b/docs/dependabot/listRepoSecrets.md @@ -8,7 +8,10 @@ type: API method # List repository secrets -Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. +Lists all secrets available in a repository without revealing their encrypted +values. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.dependabot.listRepoSecrets({ @@ -40,12 +43,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/dependabot/listSelectedReposForOrgSecret.md b/docs/dependabot/listSelectedReposForOrgSecret.md index 88df94629..1d1aeeef8 100644 --- a/docs/dependabot/listSelectedReposForOrgSecret.md +++ b/docs/dependabot/listSelectedReposForOrgSecret.md @@ -8,7 +8,10 @@ type: API method # List selected repositories for an organization secret -Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. +Lists all repositories that have been selected when the `visibility` +for repository access to a secret is set to `selected`. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.dependabot.listSelectedReposForOrgSecret({ @@ -40,12 +43,12 @@ The name of the secret. pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/dependabot/removeSelectedRepoFromOrgSecret.md b/docs/dependabot/removeSelectedRepoFromOrgSecret.md index f04e3b33f..d1b6078f6 100644 --- a/docs/dependabot/removeSelectedRepoFromOrgSecret.md +++ b/docs/dependabot/removeSelectedRepoFromOrgSecret.md @@ -8,7 +8,11 @@ type: API method # Remove selected repository from an organization secret -Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. +Removes a repository from an organization secret when the `visibility` +for repository access is set to `selected`. The visibility is set when you [Create +or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.dependabot.removeSelectedRepoFromOrgSecret({ diff --git a/docs/dependabot/setSelectedReposForOrgSecret.md b/docs/dependabot/setSelectedReposForOrgSecret.md index efdca8837..e9b3ec228 100644 --- a/docs/dependabot/setSelectedReposForOrgSecret.md +++ b/docs/dependabot/setSelectedReposForOrgSecret.md @@ -8,7 +8,11 @@ type: API method # Set selected repositories for an organization secret -Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. +Replaces all repositories for an organization secret when the `visibility` +for repository access is set to `selected`. The visibility is set when you [Create +or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.dependabot.setSelectedReposForOrgSecret({ diff --git a/docs/dependabot/updateAlert.md b/docs/dependabot/updateAlert.md index 4db605317..58519e170 100644 --- a/docs/dependabot/updateAlert.md +++ b/docs/dependabot/updateAlert.md @@ -8,11 +8,9 @@ type: API method # Update a Dependabot alert -You must use an access token with the `security_events` scope to use this endpoint with private repositories. -You can also use tokens with the `public_repo` scope for public repositories only. -GitHub Apps must have **Dependabot alerts** write permission to use this endpoint. +The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." -To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. ```js octokit.rest.dependabot.updateAlert({ diff --git a/docs/dependencyGraph/createRepositorySnapshot.md b/docs/dependencyGraph/createRepositorySnapshot.md index efc2d8249..ac1d21aa9 100644 --- a/docs/dependencyGraph/createRepositorySnapshot.md +++ b/docs/dependencyGraph/createRepositorySnapshot.md @@ -8,7 +8,11 @@ type: API method # Create a snapshot of dependencies for a repository -Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to. +Create a new snapshot of a repository's dependencies. + +The authenticated user must have access to the repository. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.dependencyGraph.createRepositorySnapshot({ diff --git a/docs/gists/createComment.md b/docs/gists/createComment.md index 73f57bda6..81f9376fa 100644 --- a/docs/gists/createComment.md +++ b/docs/gists/createComment.md @@ -8,6 +8,13 @@ type: API method # Create a gist comment +Creates a comment on a gist. + +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. +- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + ```js octokit.rest.gists.createComment({ gist_id, diff --git a/docs/gists/get.md b/docs/gists/get.md index a6aa3ee2b..05e17eaa4 100644 --- a/docs/gists/get.md +++ b/docs/gists/get.md @@ -8,6 +8,13 @@ type: API method # Get a gist +Gets a specified gist. + +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. +- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + ```js octokit.rest.gists.get({ gist_id, diff --git a/docs/gists/getComment.md b/docs/gists/getComment.md index 885677136..4dd6b9796 100644 --- a/docs/gists/getComment.md +++ b/docs/gists/getComment.md @@ -8,6 +8,13 @@ type: API method # Get a gist comment +Gets a comment on a gist. + +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. +- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + ```js octokit.rest.gists.getComment({ gist_id, diff --git a/docs/gists/getRevision.md b/docs/gists/getRevision.md index af08cda7b..99f75b533 100644 --- a/docs/gists/getRevision.md +++ b/docs/gists/getRevision.md @@ -8,6 +8,13 @@ type: API method # Get a gist revision +Gets a specified gist revision. + +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. +- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + ```js octokit.rest.gists.getRevision({ gist_id, diff --git a/docs/gists/list.md b/docs/gists/list.md index ef2fd15cf..b07c590e1 100644 --- a/docs/gists/list.md +++ b/docs/gists/list.md @@ -32,12 +32,12 @@ Only show results that were last updated after the given time. This is a timesta per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/gists/listComments.md b/docs/gists/listComments.md index 8a6f4ff3f..a2d999547 100644 --- a/docs/gists/listComments.md +++ b/docs/gists/listComments.md @@ -8,6 +8,13 @@ type: API method # List gist comments +Lists the comments on a gist. + +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. +- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + ```js octokit.rest.gists.listComments({ gist_id, @@ -32,12 +39,12 @@ The unique identifier of the gist. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/gists/listCommits.md b/docs/gists/listCommits.md index b35517039..06911203c 100644 --- a/docs/gists/listCommits.md +++ b/docs/gists/listCommits.md @@ -32,12 +32,12 @@ The unique identifier of the gist. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/gists/listForUser.md b/docs/gists/listForUser.md index 76cb40ff1..d32824a52 100644 --- a/docs/gists/listForUser.md +++ b/docs/gists/listForUser.md @@ -39,12 +39,12 @@ Only show results that were last updated after the given time. This is a timesta per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/gists/listForks.md b/docs/gists/listForks.md index 662521356..9efac6f4b 100644 --- a/docs/gists/listForks.md +++ b/docs/gists/listForks.md @@ -32,12 +32,12 @@ The unique identifier of the gist. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/gists/listPublic.md b/docs/gists/listPublic.md index 1b4d05ed0..3bb4d9cec 100644 --- a/docs/gists/listPublic.md +++ b/docs/gists/listPublic.md @@ -10,7 +10,7 @@ type: API method List public gists sorted by most recently updated to least recently updated. -Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. +Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. ```js octokit.rest.gists.listPublic(); @@ -34,12 +34,12 @@ Only show results that were last updated after the given time. This is a timesta per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/gists/listStarred.md b/docs/gists/listStarred.md index ab8ed3df4..bbce471eb 100644 --- a/docs/gists/listStarred.md +++ b/docs/gists/listStarred.md @@ -32,12 +32,12 @@ Only show results that were last updated after the given time. This is a timesta per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/gists/star.md b/docs/gists/star.md index 1b2e14a88..fe5062fe2 100644 --- a/docs/gists/star.md +++ b/docs/gists/star.md @@ -8,7 +8,7 @@ type: API method # Star a gist -Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." +Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." ```js octokit.rest.gists.star({ diff --git a/docs/gists/updateComment.md b/docs/gists/updateComment.md index 3aae80f9b..2823a1b0f 100644 --- a/docs/gists/updateComment.md +++ b/docs/gists/updateComment.md @@ -8,6 +8,13 @@ type: API method # Update a gist comment +Updates a comment on a gist. + +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. +- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + ```js octokit.rest.gists.updateComment({ gist_id, diff --git a/docs/git/getBlob.md b/docs/git/getBlob.md index 1c5eca8ef..070ea3f65 100644 --- a/docs/git/getBlob.md +++ b/docs/git/getBlob.md @@ -10,7 +10,12 @@ type: API method The `content` in the response will always be Base64 encoded. -_Note_: This API supports blobs up to 100 megabytes in size. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw blob data. +- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + +**Note** This endpoint supports blobs up to 100 megabytes in size. ```js octokit.rest.git.getBlob({ diff --git a/docs/gitignore/getTemplate.md b/docs/gitignore/getTemplate.md index 52319f79d..718fcbafa 100644 --- a/docs/gitignore/getTemplate.md +++ b/docs/gitignore/getTemplate.md @@ -8,8 +8,11 @@ type: API method # Get a gitignore template -The API also allows fetching the source of a single template. -Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. +Get the content of a gitignore template. + +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. ```js octokit.rest.gitignore.getTemplate({ diff --git a/docs/issues/create.md b/docs/issues/create.md index b8da82418..c797806bb 100644 --- a/docs/issues/create.md +++ b/docs/issues/create.md @@ -10,7 +10,15 @@ type: API method Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. -This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" +and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.issues.create({ diff --git a/docs/issues/createComment.md b/docs/issues/createComment.md index b25444771..a1f42d88a 100644 --- a/docs/issues/createComment.md +++ b/docs/issues/createComment.md @@ -12,9 +12,15 @@ You can use the REST API to create comments on issues and pull requests. Every p This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. -See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" -and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" -for details. +For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" +and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.issues.createComment({ diff --git a/docs/issues/get.md b/docs/issues/get.md index 86af69459..815afab2a 100644 --- a/docs/issues/get.md +++ b/docs/issues/get.md @@ -8,7 +8,7 @@ type: API method # Get an issue -The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was +The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read @@ -20,6 +20,13 @@ reason, "Issues" endpoints may return both issues and pull requests in the respo the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.issues.get({ owner, diff --git a/docs/issues/getComment.md b/docs/issues/getComment.md index b6f258c36..09160467e 100644 --- a/docs/issues/getComment.md +++ b/docs/issues/getComment.md @@ -10,6 +10,13 @@ type: API method You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.issues.getComment({ owner, diff --git a/docs/issues/list.md b/docs/issues/list.md index ae32b94d9..b120549d3 100644 --- a/docs/issues/list.md +++ b/docs/issues/list.md @@ -17,6 +17,13 @@ reason, "Issues" endpoints may return both issues and pull requests in the respo the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.issues.list(); ``` @@ -76,12 +83,12 @@ Only show results that were last updated after the given time. This is a timesta per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/listAssignees.md b/docs/issues/listAssignees.md index 9993e7091..59a52b8a6 100644 --- a/docs/issues/listAssignees.md +++ b/docs/issues/listAssignees.md @@ -40,12 +40,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/listComments.md b/docs/issues/listComments.md index ecb878c9d..a00c3f9ee 100644 --- a/docs/issues/listComments.md +++ b/docs/issues/listComments.md @@ -12,6 +12,13 @@ You can use the REST API to list comments on issues and pull requests. Every pul Issue comments are ordered by ascending ID. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.issues.listComments({ owner, @@ -53,12 +60,12 @@ Only show results that were last updated after the given time. This is a timesta per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/listCommentsForRepo.md b/docs/issues/listCommentsForRepo.md index 639fcdd26..9188c671b 100644 --- a/docs/issues/listCommentsForRepo.md +++ b/docs/issues/listCommentsForRepo.md @@ -12,6 +12,13 @@ You can use the REST API to list comments on issues and pull requests for a repo By default, issue comments are ordered by ascending ID. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.issues.listCommentsForRepo({ owner, @@ -57,12 +64,12 @@ Only show results that were last updated after the given time. This is a timesta per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/listEvents.md b/docs/issues/listEvents.md index 4720097a4..054d98db0 100644 --- a/docs/issues/listEvents.md +++ b/docs/issues/listEvents.md @@ -46,12 +46,12 @@ The number that identifies the issue. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/listEventsForRepo.md b/docs/issues/listEventsForRepo.md index 79f75c014..483f8614c 100644 --- a/docs/issues/listEventsForRepo.md +++ b/docs/issues/listEventsForRepo.md @@ -40,12 +40,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/listEventsForTimeline.md b/docs/issues/listEventsForTimeline.md index 6ede2bd09..bffca298c 100644 --- a/docs/issues/listEventsForTimeline.md +++ b/docs/issues/listEventsForTimeline.md @@ -46,12 +46,12 @@ The number that identifies the issue. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/listForAuthenticatedUser.md b/docs/issues/listForAuthenticatedUser.md index e2bea40bb..92efbaffe 100644 --- a/docs/issues/listForAuthenticatedUser.md +++ b/docs/issues/listForAuthenticatedUser.md @@ -15,6 +15,13 @@ reason, "Issues" endpoints may return both issues and pull requests in the respo the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.issues.listForAuthenticatedUser(); ``` @@ -62,12 +69,12 @@ Only show results that were last updated after the given time. This is a timesta per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/listForOrg.md b/docs/issues/listForOrg.md index 6856edac2..fc797747d 100644 --- a/docs/issues/listForOrg.md +++ b/docs/issues/listForOrg.md @@ -15,6 +15,13 @@ reason, "Issues" endpoints may return both issues and pull requests in the respo the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.issues.listForOrg({ org, @@ -69,12 +76,12 @@ Only show results that were last updated after the given time. This is a timesta per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/listForRepo.md b/docs/issues/listForRepo.md index 5b1b5cbd3..fac415766 100644 --- a/docs/issues/listForRepo.md +++ b/docs/issues/listForRepo.md @@ -15,6 +15,13 @@ reason, "Issues" endpoints may return both issues and pull requests in the respo the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.issues.listForRepo({ owner, @@ -90,12 +97,12 @@ Only show results that were last updated after the given time. This is a timesta per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/listLabelsForMilestone.md b/docs/issues/listLabelsForMilestone.md index 31eeeae16..5f69a8577 100644 --- a/docs/issues/listLabelsForMilestone.md +++ b/docs/issues/listLabelsForMilestone.md @@ -46,12 +46,12 @@ The number that identifies the milestone. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/listLabelsForRepo.md b/docs/issues/listLabelsForRepo.md index 060e7efae..71a3fe00d 100644 --- a/docs/issues/listLabelsForRepo.md +++ b/docs/issues/listLabelsForRepo.md @@ -40,12 +40,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/listLabelsOnIssue.md b/docs/issues/listLabelsOnIssue.md index 6667b789a..837d4fe22 100644 --- a/docs/issues/listLabelsOnIssue.md +++ b/docs/issues/listLabelsOnIssue.md @@ -46,12 +46,12 @@ The number that identifies the issue. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/listMilestones.md b/docs/issues/listMilestones.md index e386750d3..7a6b53ece 100644 --- a/docs/issues/listMilestones.md +++ b/docs/issues/listMilestones.md @@ -55,12 +55,12 @@ The direction of the sort. Either `asc` or `desc`. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/issues/lock.md b/docs/issues/lock.md index 68d7ce7af..7b6d5b920 100644 --- a/docs/issues/lock.md +++ b/docs/issues/lock.md @@ -10,7 +10,7 @@ type: API method Users with push access can lock an issue or pull request's conversation. -Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." +Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." ```js octokit.rest.issues.lock({ diff --git a/docs/issues/update.md b/docs/issues/update.md index 817e3b312..3b4c05862 100644 --- a/docs/issues/update.md +++ b/docs/issues/update.md @@ -10,6 +10,13 @@ type: API method Issue owners and users with push access can edit an issue. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.issues.update({ owner, diff --git a/docs/issues/updateComment.md b/docs/issues/updateComment.md index ca4170d41..6d8c2f088 100644 --- a/docs/issues/updateComment.md +++ b/docs/issues/updateComment.md @@ -10,6 +10,13 @@ type: API method You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.issues.updateComment({ owner, diff --git a/docs/licenses/getAllCommonlyUsed.md b/docs/licenses/getAllCommonlyUsed.md index c616cf1d9..71f9e2a55 100644 --- a/docs/licenses/getAllCommonlyUsed.md +++ b/docs/licenses/getAllCommonlyUsed.md @@ -30,12 +30,12 @@ octokit.rest.licenses.getAllCommonlyUsed(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/licenses/getForRepo.md b/docs/licenses/getForRepo.md index 11bddced6..2550c6025 100644 --- a/docs/licenses/getForRepo.md +++ b/docs/licenses/getForRepo.md @@ -10,7 +10,10 @@ type: API method This method returns the contents of the repository's license file, if one is detected. -Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw contents of the license. +- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). ```js octokit.rest.licenses.getForRepo({ diff --git a/docs/migrations/listForAuthenticatedUser.md b/docs/migrations/listForAuthenticatedUser.md index 8c77b01f4..064031e9a 100644 --- a/docs/migrations/listForAuthenticatedUser.md +++ b/docs/migrations/listForAuthenticatedUser.md @@ -27,12 +27,12 @@ octokit.rest.migrations.listForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/migrations/listForOrg.md b/docs/migrations/listForOrg.md index 99d0f1467..6f0b89fc2 100644 --- a/docs/migrations/listForOrg.md +++ b/docs/migrations/listForOrg.md @@ -36,12 +36,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." excludeno diff --git a/docs/migrations/listReposForAuthenticatedUser.md b/docs/migrations/listReposForAuthenticatedUser.md index 49d2ac91b..3ab568e40 100644 --- a/docs/migrations/listReposForAuthenticatedUser.md +++ b/docs/migrations/listReposForAuthenticatedUser.md @@ -34,12 +34,12 @@ The unique identifier of the migration. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/migrations/listReposForOrg.md b/docs/migrations/listReposForOrg.md index 6a8a2e2fa..945cb566d 100644 --- a/docs/migrations/listReposForOrg.md +++ b/docs/migrations/listReposForOrg.md @@ -40,12 +40,12 @@ The unique identifier of the migration. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/migrations/listReposForUser.md b/docs/migrations/listReposForUser.md index 2bb9bddca..5633758c0 100644 --- a/docs/migrations/listReposForUser.md +++ b/docs/migrations/listReposForUser.md @@ -36,12 +36,12 @@ The unique identifier of the migration. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/addSecurityManagerTeam.md b/docs/orgs/addSecurityManagerTeam.md index ed0dc95c3..a94d34de8 100644 --- a/docs/orgs/addSecurityManagerTeam.md +++ b/docs/orgs/addSecurityManagerTeam.md @@ -10,9 +10,9 @@ type: API method Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." -To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope. +The authenticated user must be an administrator for the organization to use this endpoint. -GitHub Apps must have the `administration` organization read-write 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.orgs.addSecurityManagerTeam({ diff --git a/docs/orgs/assignTeamToOrgRole.md b/docs/orgs/assignTeamToOrgRole.md new file mode 100644 index 000000000..c0772d0fb --- /dev/null +++ b/docs/orgs/assignTeamToOrgRole.md @@ -0,0 +1,54 @@ +--- +name: Assign an organization role to a team +example: octokit.rest.orgs.assignTeamToOrgRole({ org, team_slug, role_id }) +route: PUT /orgs/{org}/organization-roles/teams/{team_slug}/{role_id} +scope: orgs +type: API method +--- + +# Assign an organization role to a team + +Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +The authenticated user must be an administrator for the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.assignTeamToOrgRole({ + org, + team_slug, + role_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
team_slugyes + +The slug of the team name. + +
role_idyes + +The unique identifier of the role. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team). diff --git a/docs/orgs/assignUserToOrgRole.md b/docs/orgs/assignUserToOrgRole.md new file mode 100644 index 000000000..fecb69e2e --- /dev/null +++ b/docs/orgs/assignUserToOrgRole.md @@ -0,0 +1,54 @@ +--- +name: Assign an organization role to a user +example: octokit.rest.orgs.assignUserToOrgRole({ org, username, role_id }) +route: PUT /orgs/{org}/organization-roles/users/{username}/{role_id} +scope: orgs +type: API method +--- + +# Assign an organization role to a user + +Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +The authenticated user must be an administrator for the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.assignUserToOrgRole({ + org, + username, + role_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
usernameyes + +The handle for the GitHub user account. + +
role_idyes + +The unique identifier of the role. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user). diff --git a/docs/orgs/createCustomOrganizationRole.md b/docs/orgs/createCustomOrganizationRole.md new file mode 100644 index 000000000..1dd665be4 --- /dev/null +++ b/docs/orgs/createCustomOrganizationRole.md @@ -0,0 +1,62 @@ +--- +name: Create a custom organization role +example: octokit.rest.orgs.createCustomOrganizationRole({ org, name, permissions }) +route: POST /orgs/{org}/organization-roles +scope: orgs +type: API method +--- + +# Create a custom organization role + +Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +To use this endpoint, the authenticated user must be one of: + +- An administrator for the organization. +- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.createCustomOrganizationRole({ + org, + name, + permissions, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
nameyes + +The name of the custom role. + +
descriptionno + +A short description about the intended usage of this role or what permissions it grants. + +
permissionsyes + +A list of additional permissions included in this role. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#create-a-custom-organization-role). diff --git a/docs/orgs/createInvitation.md b/docs/orgs/createInvitation.md index d6726eccb..9f80cef4d 100644 --- a/docs/orgs/createInvitation.md +++ b/docs/orgs/createInvitation.md @@ -10,7 +10,8 @@ type: API method Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. -This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" +and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." ```js octokit.rest.orgs.createInvitation({ @@ -51,6 +52,7 @@ The role for the new member. - `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. - `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. - `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. +- `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. team_idsno diff --git a/docs/orgs/createOrUpdateCustomProperties.md b/docs/orgs/createOrUpdateCustomProperties.md index ff020ef9c..d8bebdc9a 100644 --- a/docs/orgs/createOrUpdateCustomProperties.md +++ b/docs/orgs/createOrUpdateCustomProperties.md @@ -9,7 +9,11 @@ type: API method # Create or update custom properties for an organization Creates new or updates existing custom properties defined for an organization in a batch. -Only organization owners (or users with the proper permissions granted by them) can update these properties + +To use this endpoint, the authenticated user must be one of: + +- An administrator for the organization. +- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. ```js octokit.rest.orgs.createOrUpdateCustomProperties({ @@ -68,7 +72,13 @@ Short description of the property properties[].allowed_valuesno -Ordered list of allowed values of the property +An ordered list of the allowed values of the property. +The property can have up to 200 allowed values. + + +properties[].values_editable_byno + +Who can edit the values of the property diff --git a/docs/orgs/createOrUpdateCustomPropertiesValuesForRepos.md b/docs/orgs/createOrUpdateCustomPropertiesValuesForRepos.md index 9b2f0d5e4..03f079a20 100644 --- a/docs/orgs/createOrUpdateCustomPropertiesValuesForRepos.md +++ b/docs/orgs/createOrUpdateCustomPropertiesValuesForRepos.md @@ -15,7 +15,10 @@ A maximum of 30 repositories can be updated in a single request. Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. -Only organization owners (or users with the proper permissions granted by them) can update these properties +To use this endpoint, the authenticated user must be one of: + +- An administrator for the organization. +- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. ```js octokit.rest.orgs.createOrUpdateCustomPropertiesValuesForRepos({ diff --git a/docs/orgs/createOrUpdateCustomProperty.md b/docs/orgs/createOrUpdateCustomProperty.md index 6373d1f02..325d250d8 100644 --- a/docs/orgs/createOrUpdateCustomProperty.md +++ b/docs/orgs/createOrUpdateCustomProperty.md @@ -9,7 +9,11 @@ type: API method # Create or update a custom property for an organization Creates a new or updates an existing custom property that is defined for an organization. -You must be an organization owner to use this endpoint. + +To use this endpoint, the authenticated user must be one of: + +- An administrator for the organization. +- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. ```js octokit.rest.orgs.createOrUpdateCustomProperty({ @@ -62,7 +66,8 @@ Short description of the property allowed_valuesno -Ordered list of allowed values of the property +An ordered list of the allowed values of the property. +The property can have up to 200 allowed values. diff --git a/docs/orgs/deleteCustomOrganizationRole.md b/docs/orgs/deleteCustomOrganizationRole.md new file mode 100644 index 000000000..257d0fb15 --- /dev/null +++ b/docs/orgs/deleteCustomOrganizationRole.md @@ -0,0 +1,51 @@ +--- +name: Delete a custom organization role. +example: octokit.rest.orgs.deleteCustomOrganizationRole({ org, role_id }) +route: DELETE /orgs/{org}/organization-roles/{role_id} +scope: orgs +type: API method +--- + +# Delete a custom organization role. + +Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +To use this endpoint, the authenticated user must be one of: + +- An administrator for the organization. +- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.deleteCustomOrganizationRole({ + org, + role_id, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
role_idyes + +The unique identifier of the role. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#delete-a-custom-organization-role). diff --git a/docs/orgs/enableOrDisableSecurityProductOnAllOrgRepos.md b/docs/orgs/enableOrDisableSecurityProductOnAllOrgRepos.md index 3aa270d9d..7a72cc916 100644 --- a/docs/orgs/enableOrDisableSecurityProductOnAllOrgRepos.md +++ b/docs/orgs/enableOrDisableSecurityProductOnAllOrgRepos.md @@ -8,14 +8,11 @@ type: API method # Enable or disable a security feature for an organization -Enables or disables the specified security feature for all eligible repositories in an organization. +Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." -To use this endpoint, you must be an organization owner or be member of a team with the security manager role. -A token with the 'write:org' scope is also required. +The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. -GitHub Apps must have the `organization_administration:write` permission to use this endpoint. - -For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." +OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. ```js octokit.rest.orgs.enableOrDisableSecurityProductOnAllOrgRepos({ diff --git a/docs/orgs/get.md b/docs/orgs/get.md index 0e452ddae..ac5fa66d7 100644 --- a/docs/orgs/get.md +++ b/docs/orgs/get.md @@ -8,9 +8,15 @@ type: API method # Get an organization -To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). +Gets information about an organization. -GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." +When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + +To see the full details about an organization, the authenticated user must be an organization owner. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + +To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. ```js octokit.rest.orgs.get({ diff --git a/docs/orgs/getAllCustomProperties.md b/docs/orgs/getAllCustomProperties.md index 67bb61107..2b81b9f48 100644 --- a/docs/orgs/getAllCustomProperties.md +++ b/docs/orgs/getAllCustomProperties.md @@ -9,7 +9,7 @@ type: API method # Get all custom properties for an organization Gets all custom properties defined for an organization. -You must be an organization owner to use this endpoint. +Organization members can read these properties. ```js octokit.rest.orgs.getAllCustomProperties({ diff --git a/docs/orgs/getCustomProperty.md b/docs/orgs/getCustomProperty.md index 6b702c292..db5a00578 100644 --- a/docs/orgs/getCustomProperty.md +++ b/docs/orgs/getCustomProperty.md @@ -9,7 +9,7 @@ type: API method # Get a custom property for an organization Gets a custom property that is defined for an organization. -You must be an organization owner to use this endpoint. +Organization members can read these properties. ```js octokit.rest.orgs.getCustomProperty({ diff --git a/docs/orgs/getOrgRole.md b/docs/orgs/getOrgRole.md new file mode 100644 index 000000000..24a58f8a3 --- /dev/null +++ b/docs/orgs/getOrgRole.md @@ -0,0 +1,51 @@ +--- +name: Get an organization role +example: octokit.rest.orgs.getOrgRole({ org, role_id }) +route: GET /orgs/{org}/organization-roles/{role_id} +scope: orgs +type: API method +--- + +# Get an organization role + +Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +To use this endpoint, the authenticated user must be one of: + +- An administrator for the organization. +- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.getOrgRole({ + org, + role_id, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
role_idyes + +The unique identifier of the role. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role). diff --git a/docs/orgs/getWebhookConfigForOrg.md b/docs/orgs/getWebhookConfigForOrg.md index f1907d8b7..9054df5eb 100644 --- a/docs/orgs/getWebhookConfigForOrg.md +++ b/docs/orgs/getWebhookConfigForOrg.md @@ -10,7 +10,7 @@ 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)." -Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. +OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. ```js octokit.rest.orgs.getWebhookConfigForOrg({ diff --git a/docs/orgs/list.md b/docs/orgs/list.md index a7aab6d21..8327131af 100644 --- a/docs/orgs/list.md +++ b/docs/orgs/list.md @@ -34,7 +34,7 @@ An organization ID. Only return organizations with an ID greater than this ID. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/listAppInstallations.md b/docs/orgs/listAppInstallations.md index 6367a725f..79bb8ff11 100644 --- a/docs/orgs/listAppInstallations.md +++ b/docs/orgs/listAppInstallations.md @@ -8,7 +8,12 @@ type: API method # List app installations for an organization -Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. +Lists all GitHub Apps in an organization. The installation count includes +all GitHub Apps installed on repositories in the organization. + +The authenticated user must be an organization owner to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. ```js octokit.rest.orgs.listAppInstallations({ @@ -34,12 +39,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/listBlockedUsers.md b/docs/orgs/listBlockedUsers.md index 714bb81f4..f5b7bab9a 100644 --- a/docs/orgs/listBlockedUsers.md +++ b/docs/orgs/listBlockedUsers.md @@ -34,12 +34,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/listCustomPropertiesValuesForRepos.md b/docs/orgs/listCustomPropertiesValuesForRepos.md index 2d3755d37..7f274d4db 100644 --- a/docs/orgs/listCustomPropertiesValuesForRepos.md +++ b/docs/orgs/listCustomPropertiesValuesForRepos.md @@ -35,12 +35,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." repository_queryno diff --git a/docs/orgs/listFailedInvitations.md b/docs/orgs/listFailedInvitations.md index f7836bb7e..6694380e6 100644 --- a/docs/orgs/listFailedInvitations.md +++ b/docs/orgs/listFailedInvitations.md @@ -34,12 +34,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/listForAuthenticatedUser.md b/docs/orgs/listForAuthenticatedUser.md index e3685044a..034731df9 100644 --- a/docs/orgs/listForAuthenticatedUser.md +++ b/docs/orgs/listForAuthenticatedUser.md @@ -10,9 +10,7 @@ type: API method List organizations for the authenticated user. -**OAuth scope requirements** - -This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. +For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. ```js octokit.rest.orgs.listForAuthenticatedUser(); @@ -31,12 +29,12 @@ octokit.rest.orgs.listForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/listForUser.md b/docs/orgs/listForUser.md index 48e22d8e9..370b4dd50 100644 --- a/docs/orgs/listForUser.md +++ b/docs/orgs/listForUser.md @@ -36,12 +36,12 @@ The handle for the GitHub user account. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/listInvitationTeams.md b/docs/orgs/listInvitationTeams.md index e59524a69..ce4ea71a8 100644 --- a/docs/orgs/listInvitationTeams.md +++ b/docs/orgs/listInvitationTeams.md @@ -40,12 +40,12 @@ The unique identifier of the invitation. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/listMembers.md b/docs/orgs/listMembers.md index f562647f7..879cd183f 100644 --- a/docs/orgs/listMembers.md +++ b/docs/orgs/listMembers.md @@ -44,12 +44,12 @@ Filter members returned by their role. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/listMembershipsForAuthenticatedUser.md b/docs/orgs/listMembershipsForAuthenticatedUser.md index 1d0490f0e..e41ea269c 100644 --- a/docs/orgs/listMembershipsForAuthenticatedUser.md +++ b/docs/orgs/listMembershipsForAuthenticatedUser.md @@ -32,12 +32,12 @@ Indicates the state of the memberships to return. If not specified, the API retu per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/listOrgRoleTeams.md b/docs/orgs/listOrgRoleTeams.md new file mode 100644 index 000000000..eba229b2d --- /dev/null +++ b/docs/orgs/listOrgRoleTeams.md @@ -0,0 +1,58 @@ +--- +name: List teams that are assigned to an organization role +example: octokit.rest.orgs.listOrgRoleTeams({ org, role_id }) +route: GET /orgs/{org}/organization-roles/{role_id}/teams +scope: orgs +type: API method +--- + +# List teams that are assigned to an organization role + +Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +To use this endpoint, you must be an administrator for the organization. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.listOrgRoleTeams({ + org, + role_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
role_idyes + +The unique identifier of the role. + +
per_pageno + +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + +
pageno + +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role). diff --git a/docs/orgs/listOrgRoleUsers.md b/docs/orgs/listOrgRoleUsers.md new file mode 100644 index 000000000..88433d4d2 --- /dev/null +++ b/docs/orgs/listOrgRoleUsers.md @@ -0,0 +1,58 @@ +--- +name: List users that are assigned to an organization role +example: octokit.rest.orgs.listOrgRoleUsers({ org, role_id }) +route: GET /orgs/{org}/organization-roles/{role_id}/users +scope: orgs +type: API method +--- + +# List users that are assigned to an organization role + +Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +To use this endpoint, you must be an administrator for the organization. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.listOrgRoleUsers({ + org, + role_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
role_idyes + +The unique identifier of the role. + +
per_pageno + +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + +
pageno + +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role). diff --git a/docs/orgs/listOrgRoles.md b/docs/orgs/listOrgRoles.md new file mode 100644 index 000000000..2b21c1a5a --- /dev/null +++ b/docs/orgs/listOrgRoles.md @@ -0,0 +1,45 @@ +--- +name: Get all organization roles for an organization +example: octokit.rest.orgs.listOrgRoles({ org }) +route: GET /orgs/{org}/organization-roles +scope: orgs +type: API method +--- + +# Get all organization roles for an organization + +Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +To use this endpoint, the authenticated user must be one of: + +- An administrator for the organization. +- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.listOrgRoles({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization). diff --git a/docs/orgs/listOrganizationFineGrainedPermissions.md b/docs/orgs/listOrganizationFineGrainedPermissions.md new file mode 100644 index 000000000..4d408e4bc --- /dev/null +++ b/docs/orgs/listOrganizationFineGrainedPermissions.md @@ -0,0 +1,47 @@ +--- +name: List organization fine-grained permissions for an organization +example: octokit.rest.orgs.listOrganizationFineGrainedPermissions({ org }) +route: GET /orgs/{org}/organization-fine-grained-permissions +scope: orgs +type: API method +--- + +# List organization fine-grained permissions for an organization + +Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + +To use this endpoint, the authenticated user must be one of: + +- An administrator for the organization. +- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.listOrganizationFineGrainedPermissions({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization). diff --git a/docs/orgs/listOutsideCollaborators.md b/docs/orgs/listOutsideCollaborators.md index b7aee7752..43c5c1a90 100644 --- a/docs/orgs/listOutsideCollaborators.md +++ b/docs/orgs/listOutsideCollaborators.md @@ -39,12 +39,12 @@ Filter the list of outside collaborators. `2fa_disabled` means that only outside per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/listPatGrantRepositories.md b/docs/orgs/listPatGrantRepositories.md index a131d26b4..7871ef62b 100644 --- a/docs/orgs/listPatGrantRepositories.md +++ b/docs/orgs/listPatGrantRepositories.md @@ -8,10 +8,9 @@ type: API method # List repositories a fine-grained personal access token has access to -Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API, -using the `organization_personal_access_tokens: read` permission. +Lists the repositories a fine-grained personal access token has access to. -**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. +Only GitHub Apps can use this endpoint. ```js octokit.rest.orgs.listPatGrantRepositories({ @@ -43,12 +42,12 @@ Unique identifier of the fine-grained personal access token. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/listPatGrantRequestRepositories.md b/docs/orgs/listPatGrantRequestRepositories.md index f928723f6..6c144f574 100644 --- a/docs/orgs/listPatGrantRequestRepositories.md +++ b/docs/orgs/listPatGrantRequestRepositories.md @@ -8,10 +8,9 @@ type: API method # List repositories requested to be accessed by a fine-grained personal access token -Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API, -using the `organization_personal_access_token_requests: read` permission. +Lists the repositories a fine-grained personal access token request is requesting access to. -**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. +Only GitHub Apps can use this endpoint. ```js octokit.rest.orgs.listPatGrantRequestRepositories({ @@ -43,12 +42,12 @@ Unique identifier of the request for access via fine-grained personal access tok per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/listPatGrantRequests.md b/docs/orgs/listPatGrantRequests.md index 6c0ce282f..04d56df9b 100644 --- a/docs/orgs/listPatGrantRequests.md +++ b/docs/orgs/listPatGrantRequests.md @@ -8,10 +8,9 @@ type: API method # List requests to access organization resources with fine-grained personal access tokens -Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API, -using the `organization_personal_access_token_requests: read` permission. +Lists requests from organization members to access organization resources with a fine-grained personal access token. -**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. +Only GitHub Apps can use this endpoint. ```js octokit.rest.orgs.listPatGrantRequests({ @@ -37,12 +36,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." sortno diff --git a/docs/orgs/listPatGrants.md b/docs/orgs/listPatGrants.md index 60c5d4c8d..7ba13ba7e 100644 --- a/docs/orgs/listPatGrants.md +++ b/docs/orgs/listPatGrants.md @@ -8,10 +8,9 @@ type: API method # List fine-grained personal access tokens with access to organization resources -Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API, -using the `organization_personal_access_tokens: read` permission. +Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. -**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. +Only GitHub Apps can use this endpoint. ```js octokit.rest.orgs.listPatGrants({ @@ -37,12 +36,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." sortno diff --git a/docs/orgs/listPendingInvitations.md b/docs/orgs/listPendingInvitations.md index 9c6f66252..7a114eca3 100644 --- a/docs/orgs/listPendingInvitations.md +++ b/docs/orgs/listPendingInvitations.md @@ -34,12 +34,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." roleno diff --git a/docs/orgs/listPublicMembers.md b/docs/orgs/listPublicMembers.md index 7db234a36..f26e7d0eb 100644 --- a/docs/orgs/listPublicMembers.md +++ b/docs/orgs/listPublicMembers.md @@ -34,12 +34,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/listSecurityManagerTeams.md b/docs/orgs/listSecurityManagerTeams.md index a802f4e4d..ab7cfb206 100644 --- a/docs/orgs/listSecurityManagerTeams.md +++ b/docs/orgs/listSecurityManagerTeams.md @@ -10,9 +10,9 @@ type: API method Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." -To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope. +The authenticated user must be an administrator or security manager for the organization to use this endpoint. -GitHub Apps must have the `administration` organization read 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.orgs.listSecurityManagerTeams({ diff --git a/docs/orgs/listWebhookDeliveries.md b/docs/orgs/listWebhookDeliveries.md index 9c93aba5c..cab01272f 100644 --- a/docs/orgs/listWebhookDeliveries.md +++ b/docs/orgs/listWebhookDeliveries.md @@ -40,7 +40,7 @@ The unique identifier of the hook. You can find this value in the `X-GitHub-Hook per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." cursorno diff --git a/docs/orgs/listWebhooks.md b/docs/orgs/listWebhooks.md index d705e5114..d4558c113 100644 --- a/docs/orgs/listWebhooks.md +++ b/docs/orgs/listWebhooks.md @@ -32,12 +32,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/orgs/patchCustomOrganizationRole.md b/docs/orgs/patchCustomOrganizationRole.md new file mode 100644 index 000000000..4eff145e6 --- /dev/null +++ b/docs/orgs/patchCustomOrganizationRole.md @@ -0,0 +1,66 @@ +--- +name: Update a custom organization role +example: octokit.rest.orgs.patchCustomOrganizationRole({ org, role_id }) +route: PATCH /orgs/{org}/organization-roles/{role_id} +scope: orgs +type: API method +--- + +# Update a custom organization role + +Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +To use this endpoint, the authenticated user must be one of: + +- An administrator for the organization. +- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.patchCustomOrganizationRole({ + org, + role_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
role_idyes + +The unique identifier of the role. + +
nameno + +The name of the custom role. + +
descriptionno + +A short description about the intended usage of this role or what permissions it grants. + +
permissionsno + +A list of additional permissions included in this role. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#update-a-custom-organization-role). diff --git a/docs/orgs/removeCustomProperty.md b/docs/orgs/removeCustomProperty.md index 5131c70e4..be9bab842 100644 --- a/docs/orgs/removeCustomProperty.md +++ b/docs/orgs/removeCustomProperty.md @@ -9,7 +9,11 @@ type: API method # Remove a custom property for an organization Removes a custom property that is defined for an organization. -You must be an organization owner to use this endpoint. + +To use this endpoint, the authenticated user must be one of: + +- An administrator for the organization. +- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. ```js octokit.rest.orgs.removeCustomProperty({ diff --git a/docs/orgs/removeSecurityManagerTeam.md b/docs/orgs/removeSecurityManagerTeam.md index 9e81f55fa..4c6277897 100644 --- a/docs/orgs/removeSecurityManagerTeam.md +++ b/docs/orgs/removeSecurityManagerTeam.md @@ -10,9 +10,9 @@ type: API method Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." -To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. +The authenticated user must be an administrator for the organization to use this endpoint. -GitHub Apps must have the `administration` organization read-write permission to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. ```js octokit.rest.orgs.removeSecurityManagerTeam({ diff --git a/docs/orgs/reviewPatGrantRequest.md b/docs/orgs/reviewPatGrantRequest.md index 9ed2b88d4..86657c8cc 100644 --- a/docs/orgs/reviewPatGrantRequest.md +++ b/docs/orgs/reviewPatGrantRequest.md @@ -8,10 +8,9 @@ type: API method # Review a request to access organization resources with a fine-grained personal access token -Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, -using the `organization_personal_access_token_requests: write` permission. +Approves or denies a pending request to access organization resources via a fine-grained personal access token. -**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. +Only GitHub Apps can use this endpoint. ```js octokit.rest.orgs.reviewPatGrantRequest({ diff --git a/docs/orgs/reviewPatGrantRequestsInBulk.md b/docs/orgs/reviewPatGrantRequestsInBulk.md index 5c45846f7..c3e9ff5b2 100644 --- a/docs/orgs/reviewPatGrantRequestsInBulk.md +++ b/docs/orgs/reviewPatGrantRequestsInBulk.md @@ -8,10 +8,9 @@ type: API method # Review requests to access organization resources with fine-grained personal access tokens -Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, -using the `organization_personal_access_token_requests: write` permission. +Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. -**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. +Only GitHub Apps can use this endpoint. ```js octokit.rest.orgs.reviewPatGrantRequestsInBulk({ diff --git a/docs/orgs/revokeAllOrgRolesTeam.md b/docs/orgs/revokeAllOrgRolesTeam.md new file mode 100644 index 000000000..ae61ea615 --- /dev/null +++ b/docs/orgs/revokeAllOrgRolesTeam.md @@ -0,0 +1,48 @@ +--- +name: Remove all organization roles for a team +example: octokit.rest.orgs.revokeAllOrgRolesTeam({ org, team_slug }) +route: DELETE /orgs/{org}/organization-roles/teams/{team_slug} +scope: orgs +type: API method +--- + +# Remove all organization roles for a team + +Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +The authenticated user must be an administrator for the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.revokeAllOrgRolesTeam({ + org, + team_slug, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
team_slugyes + +The slug of the team name. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team). diff --git a/docs/orgs/revokeAllOrgRolesUser.md b/docs/orgs/revokeAllOrgRolesUser.md new file mode 100644 index 000000000..05f8276b9 --- /dev/null +++ b/docs/orgs/revokeAllOrgRolesUser.md @@ -0,0 +1,48 @@ +--- +name: Remove all organization roles for a user +example: octokit.rest.orgs.revokeAllOrgRolesUser({ org, username }) +route: DELETE /orgs/{org}/organization-roles/users/{username} +scope: orgs +type: API method +--- + +# Remove all organization roles for a user + +Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +The authenticated user must be an administrator for the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.revokeAllOrgRolesUser({ + org, + username, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
usernameyes + +The handle for the GitHub user account. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user). diff --git a/docs/orgs/revokeOrgRoleTeam.md b/docs/orgs/revokeOrgRoleTeam.md new file mode 100644 index 000000000..eb25cb046 --- /dev/null +++ b/docs/orgs/revokeOrgRoleTeam.md @@ -0,0 +1,54 @@ +--- +name: Remove an organization role from a team +example: octokit.rest.orgs.revokeOrgRoleTeam({ org, team_slug, role_id }) +route: DELETE /orgs/{org}/organization-roles/teams/{team_slug}/{role_id} +scope: orgs +type: API method +--- + +# Remove an organization role from a team + +Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +The authenticated user must be an administrator for the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.revokeOrgRoleTeam({ + org, + team_slug, + role_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
team_slugyes + +The slug of the team name. + +
role_idyes + +The unique identifier of the role. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team). diff --git a/docs/orgs/revokeOrgRoleUser.md b/docs/orgs/revokeOrgRoleUser.md new file mode 100644 index 000000000..97d4a3e2f --- /dev/null +++ b/docs/orgs/revokeOrgRoleUser.md @@ -0,0 +1,54 @@ +--- +name: Remove an organization role from a user +example: octokit.rest.orgs.revokeOrgRoleUser({ org, username, role_id }) +route: DELETE /orgs/{org}/organization-roles/users/{username}/{role_id} +scope: orgs +type: API method +--- + +# Remove an organization role from a user + +Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + +The authenticated user must be an administrator for the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```js +octokit.rest.orgs.revokeOrgRoleUser({ + org, + username, + role_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
usernameyes + +The handle for the GitHub user account. + +
role_idyes + +The unique identifier of the role. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user). diff --git a/docs/orgs/setPublicMembershipForAuthenticatedUser.md b/docs/orgs/setPublicMembershipForAuthenticatedUser.md index a45ddd1a1..a8c542093 100644 --- a/docs/orgs/setPublicMembershipForAuthenticatedUser.md +++ b/docs/orgs/setPublicMembershipForAuthenticatedUser.md @@ -10,7 +10,7 @@ type: API method The user can publicize their own membership. (A user cannot publicize the membership for another user.) -Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." +Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." ```js octokit.rest.orgs.setPublicMembershipForAuthenticatedUser({ diff --git a/docs/orgs/update.md b/docs/orgs/update.md index 65f2789c3..ee4bc4766 100644 --- a/docs/orgs/update.md +++ b/docs/orgs/update.md @@ -10,7 +10,11 @@ type: API method **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). -Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. +Updates the organization's profile and member privileges. + +The authenticated user must be an organization owner to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. ```js octokit.rest.orgs.update({ diff --git a/docs/orgs/updatePatAccess.md b/docs/orgs/updatePatAccess.md index 972816c06..d06fcba6c 100644 --- a/docs/orgs/updatePatAccess.md +++ b/docs/orgs/updatePatAccess.md @@ -8,10 +8,9 @@ type: API method # Update the access a fine-grained personal access token has to organization resources -Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API, -using the `organization_personal_access_tokens: write` permission. +Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. -**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. +Only GitHub Apps can use this endpoint. ```js octokit.rest.orgs.updatePatAccess({ diff --git a/docs/orgs/updatePatAccesses.md b/docs/orgs/updatePatAccesses.md index e5d9a0419..a181fdc74 100644 --- a/docs/orgs/updatePatAccesses.md +++ b/docs/orgs/updatePatAccesses.md @@ -8,10 +8,9 @@ type: API method # Update the access to organization resources via fine-grained personal access tokens -Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API, -using the `organization_personal_access_tokens: write` permission. +Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. -**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. +Only GitHub Apps can use this endpoint. ```js octokit.rest.orgs.updatePatAccesses({ diff --git a/docs/orgs/updateWebhookConfigForOrg.md b/docs/orgs/updateWebhookConfigForOrg.md index a6163290d..c6980349c 100644 --- a/docs/orgs/updateWebhookConfigForOrg.md +++ b/docs/orgs/updateWebhookConfigForOrg.md @@ -10,7 +10,7 @@ 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)." -Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. +OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. ```js octokit.rest.orgs.updateWebhookConfigForOrg({ diff --git a/docs/packages/deletePackageForAuthenticatedUser.md b/docs/packages/deletePackageForAuthenticatedUser.md index 30510d853..52643b7ae 100644 --- a/docs/packages/deletePackageForAuthenticatedUser.md +++ b/docs/packages/deletePackageForAuthenticatedUser.md @@ -10,8 +10,7 @@ type: API method Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. -To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. -If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.deletePackageForAuthenticatedUser({ diff --git a/docs/packages/deletePackageForOrg.md b/docs/packages/deletePackageForOrg.md index bc89bf64c..a9395f14e 100644 --- a/docs/packages/deletePackageForOrg.md +++ b/docs/packages/deletePackageForOrg.md @@ -10,10 +10,9 @@ type: API method Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. -To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: +The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.deletePackageForOrg({ diff --git a/docs/packages/deletePackageForUser.md b/docs/packages/deletePackageForUser.md index 15cbfddf5..c91af3cf9 100644 --- a/docs/packages/deletePackageForUser.md +++ b/docs/packages/deletePackageForUser.md @@ -10,10 +10,9 @@ type: API method Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. -To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: +If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.deletePackageForUser({ diff --git a/docs/packages/deletePackageVersionForAuthenticatedUser.md b/docs/packages/deletePackageVersionForAuthenticatedUser.md index 65f814b7d..968113d3e 100644 --- a/docs/packages/deletePackageVersionForAuthenticatedUser.md +++ b/docs/packages/deletePackageVersionForAuthenticatedUser.md @@ -10,8 +10,9 @@ type: API method Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. -To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. -If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +The authenticated user must have admin permissions in the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.deletePackageVersionForAuthenticatedUser({ diff --git a/docs/packages/deletePackageVersionForOrg.md b/docs/packages/deletePackageVersionForOrg.md index 3d7dfebbc..c15d71098 100644 --- a/docs/packages/deletePackageVersionForOrg.md +++ b/docs/packages/deletePackageVersionForOrg.md @@ -10,10 +10,9 @@ type: API method Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. -To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: +The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.deletePackageVersionForOrg({ diff --git a/docs/packages/deletePackageVersionForUser.md b/docs/packages/deletePackageVersionForUser.md index d2f0e461e..0503ea12b 100644 --- a/docs/packages/deletePackageVersionForUser.md +++ b/docs/packages/deletePackageVersionForUser.md @@ -10,10 +10,9 @@ type: API method Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. -To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: +If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.deletePackageVersionForUser({ diff --git a/docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md b/docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md index 5d3e09145..1c0d22eaf 100644 --- a/docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md +++ b/docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md @@ -12,7 +12,7 @@ type: API method Lists package versions for a package owned by an organization. -If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.getAllPackageVersionsForAPackageOwnedByAnOrg({ @@ -50,12 +50,12 @@ The organization name. The name is not case sensitive. pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." stateno diff --git a/docs/packages/getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser.md b/docs/packages/getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser.md index 6d2a9c4fc..dd64c6454 100644 --- a/docs/packages/getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser.md +++ b/docs/packages/getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser.md @@ -12,7 +12,7 @@ type: API method Lists package versions for a package owned by the authenticated user. -To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser( @@ -46,12 +46,12 @@ The name of the package. pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." stateno diff --git a/docs/packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser.md b/docs/packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser.md index 56fbc21cd..f2816d3a2 100644 --- a/docs/packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser.md +++ b/docs/packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser.md @@ -10,7 +10,7 @@ type: API method Lists package versions for a package owned by the authenticated user. -To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser({ @@ -42,12 +42,12 @@ The name of the package. pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." stateno diff --git a/docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md b/docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md index f97518735..092057cd4 100644 --- a/docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md +++ b/docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md @@ -10,7 +10,7 @@ type: API method Lists package versions for a package owned by an organization. -If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.getAllPackageVersionsForPackageOwnedByOrg({ @@ -48,12 +48,12 @@ The organization name. The name is not case sensitive. pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." stateno diff --git a/docs/packages/getAllPackageVersionsForPackageOwnedByUser.md b/docs/packages/getAllPackageVersionsForPackageOwnedByUser.md index 0bcab0809..77c9fa9be 100644 --- a/docs/packages/getAllPackageVersionsForPackageOwnedByUser.md +++ b/docs/packages/getAllPackageVersionsForPackageOwnedByUser.md @@ -10,7 +10,7 @@ type: API method Lists package versions for a public package owned by a specified user. -To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.getAllPackageVersionsForPackageOwnedByUser({ diff --git a/docs/packages/getPackageForAuthenticatedUser.md b/docs/packages/getPackageForAuthenticatedUser.md index 2fc10465b..e8df6ab7e 100644 --- a/docs/packages/getPackageForAuthenticatedUser.md +++ b/docs/packages/getPackageForAuthenticatedUser.md @@ -10,7 +10,7 @@ type: API method Gets a specific package for a package owned by the authenticated user. -To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.getPackageForAuthenticatedUser({ diff --git a/docs/packages/getPackageForOrganization.md b/docs/packages/getPackageForOrganization.md index d00b64795..e36dd01b7 100644 --- a/docs/packages/getPackageForOrganization.md +++ b/docs/packages/getPackageForOrganization.md @@ -10,7 +10,7 @@ type: API method Gets a specific package in an organization. -To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.getPackageForOrganization({ diff --git a/docs/packages/getPackageForUser.md b/docs/packages/getPackageForUser.md index 7ed90a60e..7d6c2bcd9 100644 --- a/docs/packages/getPackageForUser.md +++ b/docs/packages/getPackageForUser.md @@ -10,7 +10,7 @@ type: API method Gets a specific package metadata for a public package owned by a user. -To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.getPackageForUser({ diff --git a/docs/packages/getPackageVersionForAuthenticatedUser.md b/docs/packages/getPackageVersionForAuthenticatedUser.md index 94ff969b6..1b341eab6 100644 --- a/docs/packages/getPackageVersionForAuthenticatedUser.md +++ b/docs/packages/getPackageVersionForAuthenticatedUser.md @@ -10,7 +10,7 @@ type: API method Gets a specific package version for a package owned by the authenticated user. -To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.getPackageVersionForAuthenticatedUser({ diff --git a/docs/packages/getPackageVersionForOrganization.md b/docs/packages/getPackageVersionForOrganization.md index 779cf59cf..0ed715c42 100644 --- a/docs/packages/getPackageVersionForOrganization.md +++ b/docs/packages/getPackageVersionForOrganization.md @@ -10,7 +10,7 @@ type: API method Gets a specific package version in an organization. -You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.getPackageVersionForOrganization({ diff --git a/docs/packages/getPackageVersionForUser.md b/docs/packages/getPackageVersionForUser.md index 3ca48425c..7bc9538a9 100644 --- a/docs/packages/getPackageVersionForUser.md +++ b/docs/packages/getPackageVersionForUser.md @@ -10,7 +10,7 @@ type: API method Gets a specific package version for a public package owned by a specified user. -At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.getPackageVersionForUser({ diff --git a/docs/packages/listDockerMigrationConflictingPackagesForAuthenticatedUser.md b/docs/packages/listDockerMigrationConflictingPackagesForAuthenticatedUser.md index 0999a1361..ff6175d07 100644 --- a/docs/packages/listDockerMigrationConflictingPackagesForAuthenticatedUser.md +++ b/docs/packages/listDockerMigrationConflictingPackagesForAuthenticatedUser.md @@ -9,7 +9,8 @@ type: API method # Get list of conflicting packages during Docker migration for authenticated-user Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. -To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. ```js octokit.rest.packages.listDockerMigrationConflictingPackagesForAuthenticatedUser(); diff --git a/docs/packages/listDockerMigrationConflictingPackagesForOrganization.md b/docs/packages/listDockerMigrationConflictingPackagesForOrganization.md index 11c4d3092..62ebfd537 100644 --- a/docs/packages/listDockerMigrationConflictingPackagesForOrganization.md +++ b/docs/packages/listDockerMigrationConflictingPackagesForOrganization.md @@ -9,7 +9,8 @@ type: API method # Get list of conflicting packages during Docker migration for organization Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. -To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. ```js octokit.rest.packages.listDockerMigrationConflictingPackagesForOrganization({ diff --git a/docs/packages/listDockerMigrationConflictingPackagesForUser.md b/docs/packages/listDockerMigrationConflictingPackagesForUser.md index e7beb345a..d2f663a53 100644 --- a/docs/packages/listDockerMigrationConflictingPackagesForUser.md +++ b/docs/packages/listDockerMigrationConflictingPackagesForUser.md @@ -9,7 +9,8 @@ type: API method # Get list of conflicting packages during Docker migration for user Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. -To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. ```js octokit.rest.packages.listDockerMigrationConflictingPackagesForUser({ diff --git a/docs/packages/listPackagesForAuthenticatedUser.md b/docs/packages/listPackagesForAuthenticatedUser.md index 799e95347..91dd29316 100644 --- a/docs/packages/listPackagesForAuthenticatedUser.md +++ b/docs/packages/listPackagesForAuthenticatedUser.md @@ -10,7 +10,7 @@ type: API method Lists packages owned by the authenticated user within the user's namespace. -To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.listPackagesForAuthenticatedUser({ @@ -44,12 +44,12 @@ For the list of GitHub Packages registries that support granular permissions, se pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/packages/listPackagesForOrganization.md b/docs/packages/listPackagesForOrganization.md index 20235654e..c34291fe3 100644 --- a/docs/packages/listPackagesForOrganization.md +++ b/docs/packages/listPackagesForOrganization.md @@ -10,7 +10,7 @@ type: API method Lists packages in an organization readable by the user. -To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.listPackagesForOrganization({ @@ -50,12 +50,12 @@ For the list of GitHub Packages registries that support granular permissions, se pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/packages/listPackagesForUser.md b/docs/packages/listPackagesForUser.md index aaba1645c..ca751c341 100644 --- a/docs/packages/listPackagesForUser.md +++ b/docs/packages/listPackagesForUser.md @@ -10,7 +10,7 @@ type: API method Lists all packages in a user's namespace for which the requesting user has access. -To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.listPackagesForUser({ @@ -50,12 +50,12 @@ The handle for the GitHub user account. pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/packages/restorePackageForAuthenticatedUser.md b/docs/packages/restorePackageForAuthenticatedUser.md index 9f5defadb..e0fd641dd 100644 --- a/docs/packages/restorePackageForAuthenticatedUser.md +++ b/docs/packages/restorePackageForAuthenticatedUser.md @@ -15,7 +15,7 @@ You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. -To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.restorePackageForAuthenticatedUser({ diff --git a/docs/packages/restorePackageForOrg.md b/docs/packages/restorePackageForOrg.md index 7d7547f89..6aa0aa67d 100644 --- a/docs/packages/restorePackageForOrg.md +++ b/docs/packages/restorePackageForOrg.md @@ -15,10 +15,9 @@ You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. -To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: +The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.restorePackageForOrg({ diff --git a/docs/packages/restorePackageForUser.md b/docs/packages/restorePackageForUser.md index 0f6ec1b91..12f3701f5 100644 --- a/docs/packages/restorePackageForUser.md +++ b/docs/packages/restorePackageForUser.md @@ -15,10 +15,9 @@ You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. -To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: +If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.restorePackageForUser({ diff --git a/docs/packages/restorePackageVersionForAuthenticatedUser.md b/docs/packages/restorePackageVersionForAuthenticatedUser.md index c2f730769..10a34a1a6 100644 --- a/docs/packages/restorePackageVersionForAuthenticatedUser.md +++ b/docs/packages/restorePackageVersionForAuthenticatedUser.md @@ -15,7 +15,7 @@ You can restore a deleted package version under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. -To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.restorePackageVersionForAuthenticatedUser({ diff --git a/docs/packages/restorePackageVersionForOrg.md b/docs/packages/restorePackageVersionForOrg.md index 74779b313..9ea0839d1 100644 --- a/docs/packages/restorePackageVersionForOrg.md +++ b/docs/packages/restorePackageVersionForOrg.md @@ -15,10 +15,9 @@ You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. -To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: +The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.restorePackageVersionForOrg({ diff --git a/docs/packages/restorePackageVersionForUser.md b/docs/packages/restorePackageVersionForUser.md index 7572bdc05..8bb791c7b 100644 --- a/docs/packages/restorePackageVersionForUser.md +++ b/docs/packages/restorePackageVersionForUser.md @@ -15,10 +15,9 @@ You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. -To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: +If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." -- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." +OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." ```js octokit.rest.packages.restorePackageVersionForUser({ diff --git a/docs/projects/listCards.md b/docs/projects/listCards.md index d2e4a9067..63e43b89f 100644 --- a/docs/projects/listCards.md +++ b/docs/projects/listCards.md @@ -39,12 +39,12 @@ Filters the project cards that are returned by the card's state. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/projects/listCollaborators.md b/docs/projects/listCollaborators.md index 60e254221..67460be9e 100644 --- a/docs/projects/listCollaborators.md +++ b/docs/projects/listCollaborators.md @@ -39,12 +39,12 @@ Filters the collaborators by their affiliation. `outside` means outside collabor per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/projects/listColumns.md b/docs/projects/listColumns.md index 4ef2c7722..c429f49a1 100644 --- a/docs/projects/listColumns.md +++ b/docs/projects/listColumns.md @@ -34,12 +34,12 @@ The unique identifier of the project. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/projects/listForOrg.md b/docs/projects/listForOrg.md index faf5a9c05..78ebd36bb 100644 --- a/docs/projects/listForOrg.md +++ b/docs/projects/listForOrg.md @@ -39,12 +39,12 @@ Indicates the state of the projects to return. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/projects/listForRepo.md b/docs/projects/listForRepo.md index fabc30000..9007c8403 100644 --- a/docs/projects/listForRepo.md +++ b/docs/projects/listForRepo.md @@ -45,12 +45,12 @@ Indicates the state of the projects to return. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/projects/listForUser.md b/docs/projects/listForUser.md index 24eb3707e..7b5e6cf52 100644 --- a/docs/projects/listForUser.md +++ b/docs/projects/listForUser.md @@ -39,12 +39,12 @@ Indicates the state of the projects to return. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/pulls/create.md b/docs/pulls/create.md index f8514c510..f1e1d5ad9 100644 --- a/docs/pulls/create.md +++ b/docs/pulls/create.md @@ -12,7 +12,15 @@ Draft pull requests are available in public repositories with GitHub Free and Gi To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. -This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. +- **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. ```js octokit.rest.pulls.create({ diff --git a/docs/pulls/createReplyForReviewComment.md b/docs/pulls/createReplyForReviewComment.md index f6215eea8..1b227134a 100644 --- a/docs/pulls/createReplyForReviewComment.md +++ b/docs/pulls/createReplyForReviewComment.md @@ -10,7 +10,15 @@ type: API method Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. -This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" +and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.pulls.createReplyForReviewComment({ diff --git a/docs/pulls/createReview.md b/docs/pulls/createReview.md index f5466e61f..5604bf78a 100644 --- a/docs/pulls/createReview.md +++ b/docs/pulls/createReview.md @@ -8,14 +8,23 @@ type: API method # Create a review for a pull request -This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +Creates a review on a specified pull request. + +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." -**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. +**Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. +This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.pulls.createReview({ owner, @@ -79,7 +88,7 @@ The relative path to the file that necessitates a review comment. comments[].positionno -The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below. +The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. comments[].bodyyes diff --git a/docs/pulls/createReviewComment.md b/docs/pulls/createReviewComment.md index 28f242406..1570fe430 100644 --- a/docs/pulls/createReviewComment.md +++ b/docs/pulls/createReviewComment.md @@ -8,13 +8,21 @@ type: API method # Create a review comment for a pull request -Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. +Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." + +If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. -**Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" +and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + +This 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)." -This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.pulls.createReviewComment({ @@ -70,7 +78,7 @@ The relative path to the file that necessitates a comment. positionno -**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. +**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. sideno diff --git a/docs/pulls/deletePendingReview.md b/docs/pulls/deletePendingReview.md index 842b54998..a9e6f2496 100644 --- a/docs/pulls/deletePendingReview.md +++ b/docs/pulls/deletePendingReview.md @@ -10,6 +10,13 @@ type: API method Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.pulls.deletePendingReview({ owner, diff --git a/docs/pulls/dismissReview.md b/docs/pulls/dismissReview.md index 1c102bdee..2b0eeb0c9 100644 --- a/docs/pulls/dismissReview.md +++ b/docs/pulls/dismissReview.md @@ -8,7 +8,18 @@ type: API method # Dismiss a review for a pull request -**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. +Dismisses a specified review on a pull request. + +**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), +you must be a repository administrator or be included in the list of people or teams +who can dismiss pull request reviews. + +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.pulls.dismissReview({ diff --git a/docs/pulls/get.md b/docs/pulls/get.md index 3d119e31c..2237a19ef 100644 --- a/docs/pulls/get.md +++ b/docs/pulls/get.md @@ -24,6 +24,14 @@ The value of the `merge_commit_sha` attribute changes depending on the state of Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. +- **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + ```js octokit.rest.pulls.get({ owner, diff --git a/docs/pulls/getReview.md b/docs/pulls/getReview.md index b1e286905..43de09448 100644 --- a/docs/pulls/getReview.md +++ b/docs/pulls/getReview.md @@ -10,6 +10,13 @@ type: API method Retrieves a pull request review by its ID. +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.pulls.getReview({ owner, diff --git a/docs/pulls/getReviewComment.md b/docs/pulls/getReviewComment.md index 0dae54994..fc5513859 100644 --- a/docs/pulls/getReviewComment.md +++ b/docs/pulls/getReviewComment.md @@ -8,7 +8,14 @@ type: API method # Get a review comment for a pull request -Provides details for a review comment. +Provides details for a specified review comment. + +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.pulls.getReviewComment({ diff --git a/docs/pulls/list.md b/docs/pulls/list.md index 810137a68..b41a7d6d8 100644 --- a/docs/pulls/list.md +++ b/docs/pulls/list.md @@ -8,7 +8,22 @@ type: API method # List pull requests -Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Lists pull requests in a specified repository. + +Draft pull requests are available in public repositories with GitHub +Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing +plans, and in public and private repositories with GitHub Team and GitHub Enterprise +Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) +in the GitHub Help documentation. + +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. +- **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. +- **`application/vnd.github.patch`**: For more information, see "[git-format-patch](https://git-scm.com/docs/git-format-patch)" in the Git documentation. ```js octokit.rest.pulls.list({ @@ -65,12 +80,12 @@ The direction of the sort. Default: `desc` when sort is `created` or sort is not per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/pulls/listCommentsForReview.md b/docs/pulls/listCommentsForReview.md index 9d450fc1c..9965b20be 100644 --- a/docs/pulls/listCommentsForReview.md +++ b/docs/pulls/listCommentsForReview.md @@ -8,7 +8,14 @@ type: API method # List comments for a pull request review -List comments for a specific pull request review. +Lists comments for a specific pull request review. + +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.pulls.listCommentsForReview({ @@ -52,12 +59,12 @@ The unique identifier of the review. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/pulls/listCommits.md b/docs/pulls/listCommits.md index 8547456ff..754880f99 100644 --- a/docs/pulls/listCommits.md +++ b/docs/pulls/listCommits.md @@ -8,7 +8,17 @@ type: API method # List commits on a pull request -Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. +Lists a maximum of 250 commits for a pull request. To receive a complete +commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) +endpoint. + +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. +- **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. ```js octokit.rest.pulls.listCommits({ @@ -46,12 +56,12 @@ The number that identifies the pull request. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/pulls/listFiles.md b/docs/pulls/listFiles.md index 60e6ee30a..44318d61d 100644 --- a/docs/pulls/listFiles.md +++ b/docs/pulls/listFiles.md @@ -8,7 +8,18 @@ type: API method # List pull requests files -**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. +Lists the files in a specified pull request. + +**Note:** Responses include a maximum of 3000 files. The paginated response +returns 30 files per page by default. + +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. +- **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. ```js octokit.rest.pulls.listFiles({ @@ -46,12 +57,12 @@ The number that identifies the pull request. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/pulls/listReviewComments.md b/docs/pulls/listReviewComments.md index 87c48b892..b3af0f449 100644 --- a/docs/pulls/listReviewComments.md +++ b/docs/pulls/listReviewComments.md @@ -8,7 +8,15 @@ type: API method # List review comments on a pull request -Lists all review comments for a pull request. By default, review comments are in ascending order by ID. +Lists all review comments for a specified pull request. By default, review comments +are in ascending order by ID. + +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.pulls.listReviewComments({ @@ -61,12 +69,12 @@ Only show results that were last updated after the given time. This is a timesta per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/pulls/listReviewCommentsForRepo.md b/docs/pulls/listReviewCommentsForRepo.md index 3ca62546e..95380e2f0 100644 --- a/docs/pulls/listReviewCommentsForRepo.md +++ b/docs/pulls/listReviewCommentsForRepo.md @@ -8,7 +8,15 @@ type: API method # List review comments in a repository -Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. +Lists review comments for all pull requests in a repository. By default, +review comments are in ascending order by ID. + +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.pulls.listReviewCommentsForRepo({ @@ -53,12 +61,12 @@ Only show results that were last updated after the given time. This is a timesta per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/pulls/listReviews.md b/docs/pulls/listReviews.md index c6e3f6235..3a6be8ef9 100644 --- a/docs/pulls/listReviews.md +++ b/docs/pulls/listReviews.md @@ -8,7 +8,14 @@ type: API method # List reviews for a pull request -The list of reviews returns in chronological order. +Lists all reviews for a specified pull request. The list of reviews returns in chronological order. + +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.pulls.listReviews({ @@ -46,12 +53,12 @@ The number that identifies the pull request. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/pulls/merge.md b/docs/pulls/merge.md index 3dd71ab99..62f47a0f7 100644 --- a/docs/pulls/merge.md +++ b/docs/pulls/merge.md @@ -9,7 +9,7 @@ type: API method # Merge a pull request Merges a pull request into the base branch. -This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." ```js octokit.rest.pulls.merge({ diff --git a/docs/pulls/submitReview.md b/docs/pulls/submitReview.md index 345111946..bcdfae534 100644 --- a/docs/pulls/submitReview.md +++ b/docs/pulls/submitReview.md @@ -10,6 +10,13 @@ type: API method Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.pulls.submitReview({ owner, diff --git a/docs/pulls/update.md b/docs/pulls/update.md index 08421d229..80fa540a1 100644 --- a/docs/pulls/update.md +++ b/docs/pulls/update.md @@ -12,6 +12,14 @@ Draft pull requests are available in public repositories with GitHub Free and Gi To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. +- **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + ```js octokit.rest.pulls.update({ owner, diff --git a/docs/pulls/updateReview.md b/docs/pulls/updateReview.md index 042f71e04..aa31db25c 100644 --- a/docs/pulls/updateReview.md +++ b/docs/pulls/updateReview.md @@ -8,7 +8,14 @@ type: API method # Update a review for a pull request -Update the review summary comment with new text. +Updates the contents of a specified review summary comment. + +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.pulls.updateReview({ diff --git a/docs/pulls/updateReviewComment.md b/docs/pulls/updateReviewComment.md index 67d1d4030..4406096a4 100644 --- a/docs/pulls/updateReviewComment.md +++ b/docs/pulls/updateReviewComment.md @@ -8,7 +8,14 @@ type: API method # Update a review comment for a pull request -Enables you to edit a review comment. +Edits the content of a specified review comment. + +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.pulls.updateReviewComment({ diff --git a/docs/rateLimit/get.md b/docs/rateLimit/get.md index a0f64225c..2f698f972 100644 --- a/docs/rateLimit/get.md +++ b/docs/rateLimit/get.md @@ -13,7 +13,7 @@ type: API method Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - The `core` object provides your rate limit status for all non-search-related resources in the REST API. -- The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." +- The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." - The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." - The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." - The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." diff --git a/docs/reactions/createForTeamDiscussionCommentInOrg.md b/docs/reactions/createForTeamDiscussionCommentInOrg.md index 85d5f051e..41ffa2896 100644 --- a/docs/reactions/createForTeamDiscussionCommentInOrg.md +++ b/docs/reactions/createForTeamDiscussionCommentInOrg.md @@ -8,10 +8,14 @@ type: API method # Create reaction for a team discussion comment -Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. +Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + +A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. +OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + ```js octokit.rest.reactions.createForTeamDiscussionCommentInOrg({ org, diff --git a/docs/reactions/createForTeamDiscussionInOrg.md b/docs/reactions/createForTeamDiscussionInOrg.md index fa431d76d..0b8a7c070 100644 --- a/docs/reactions/createForTeamDiscussionInOrg.md +++ b/docs/reactions/createForTeamDiscussionInOrg.md @@ -8,10 +8,14 @@ type: API method # Create reaction for a team discussion -Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. +Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + +A response with an HTTP `200` status means that you already added the reaction type to this team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. +OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + ```js octokit.rest.reactions.createForTeamDiscussionInOrg({ org, diff --git a/docs/reactions/deleteForTeamDiscussion.md b/docs/reactions/deleteForTeamDiscussion.md index c9566e317..3e4818af6 100644 --- a/docs/reactions/deleteForTeamDiscussion.md +++ b/docs/reactions/deleteForTeamDiscussion.md @@ -10,7 +10,9 @@ type: API method **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. -Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + +OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. ```js octokit.rest.reactions.deleteForTeamDiscussion({ diff --git a/docs/reactions/deleteForTeamDiscussionComment.md b/docs/reactions/deleteForTeamDiscussionComment.md index d612a5461..c751fb0bb 100644 --- a/docs/reactions/deleteForTeamDiscussionComment.md +++ b/docs/reactions/deleteForTeamDiscussionComment.md @@ -10,7 +10,9 @@ type: API method **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. -Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + +OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. ```js octokit.rest.reactions.deleteForTeamDiscussionComment({ diff --git a/docs/reactions/listForCommitComment.md b/docs/reactions/listForCommitComment.md index e1ce5391e..70846d209 100644 --- a/docs/reactions/listForCommitComment.md +++ b/docs/reactions/listForCommitComment.md @@ -51,12 +51,12 @@ Returns a single [reaction type](https://docs.github.com/rest/reactions/reaction per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/reactions/listForIssue.md b/docs/reactions/listForIssue.md index 723c7c0a2..505e70ed3 100644 --- a/docs/reactions/listForIssue.md +++ b/docs/reactions/listForIssue.md @@ -51,12 +51,12 @@ Returns a single [reaction type](https://docs.github.com/rest/reactions/reaction per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/reactions/listForIssueComment.md b/docs/reactions/listForIssueComment.md index 5b835d8cd..a5776b9b6 100644 --- a/docs/reactions/listForIssueComment.md +++ b/docs/reactions/listForIssueComment.md @@ -51,12 +51,12 @@ Returns a single [reaction type](https://docs.github.com/rest/reactions/reaction per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/reactions/listForPullRequestReviewComment.md b/docs/reactions/listForPullRequestReviewComment.md index a38feacbd..d3657ee79 100644 --- a/docs/reactions/listForPullRequestReviewComment.md +++ b/docs/reactions/listForPullRequestReviewComment.md @@ -51,12 +51,12 @@ Returns a single [reaction type](https://docs.github.com/rest/reactions/reaction per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/reactions/listForRelease.md b/docs/reactions/listForRelease.md index 5be638b9d..17d1a80d8 100644 --- a/docs/reactions/listForRelease.md +++ b/docs/reactions/listForRelease.md @@ -51,12 +51,12 @@ Returns a single [reaction type](https://docs.github.com/rest/reactions/reaction per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/reactions/listForTeamDiscussionCommentInOrg.md b/docs/reactions/listForTeamDiscussionCommentInOrg.md index 09075d73b..fa110cac2 100644 --- a/docs/reactions/listForTeamDiscussionCommentInOrg.md +++ b/docs/reactions/listForTeamDiscussionCommentInOrg.md @@ -8,10 +8,12 @@ type: API method # List reactions for a team discussion comment -List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. +OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + ```js octokit.rest.reactions.listForTeamDiscussionCommentInOrg({ org, @@ -59,12 +61,12 @@ Returns a single [reaction type](https://docs.github.com/rest/reactions/reaction per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/reactions/listForTeamDiscussionInOrg.md b/docs/reactions/listForTeamDiscussionInOrg.md index 1f74d982c..dfba80817 100644 --- a/docs/reactions/listForTeamDiscussionInOrg.md +++ b/docs/reactions/listForTeamDiscussionInOrg.md @@ -8,10 +8,12 @@ type: API method # List reactions for a team discussion -List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. +OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + ```js octokit.rest.reactions.listForTeamDiscussionInOrg({ org, @@ -53,12 +55,12 @@ Returns a single [reaction type](https://docs.github.com/rest/reactions/reaction per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/addAppAccessRestrictions.md b/docs/repos/addAppAccessRestrictions.md index 8cf8602f2..78d7b70c3 100644 --- a/docs/repos/addAppAccessRestrictions.md +++ b/docs/repos/addAppAccessRestrictions.md @@ -10,7 +10,7 @@ type: API method Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. -Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. +Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. ```js octokit.rest.repos.addAppAccessRestrictions({ diff --git a/docs/repos/addCollaborator.md b/docs/repos/addCollaborator.md index 4c5f2ca90..6cec7373a 100644 --- a/docs/repos/addCollaborator.md +++ b/docs/repos/addCollaborator.md @@ -8,7 +8,7 @@ type: API method # Add a repository collaborator -This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." @@ -18,7 +18,7 @@ For more information on permission levels, see "[Repository permission levels fo Cannot assign {member} permission of {role name} ``` -Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." +Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). diff --git a/docs/repos/cancelPagesDeployment.md b/docs/repos/cancelPagesDeployment.md new file mode 100644 index 000000000..2c6be06bf --- /dev/null +++ b/docs/repos/cancelPagesDeployment.md @@ -0,0 +1,52 @@ +--- +name: Cancel a GitHub Pages deployment +example: octokit.rest.repos.cancelPagesDeployment({ owner, repo, pages_deployment_id }) +route: POST /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel +scope: repos +type: API method +--- + +# Cancel a GitHub Pages deployment + +Cancels a GitHub Pages deployment. + +The authenticated user must have write permissions for the GitHub Pages site. + +```js +octokit.rest.repos.cancelPagesDeployment({ + owner, + repo, + pages_deployment_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. + +
pages_deployment_idyes + +The ID of the Pages deployment. You can also give the commit SHA of the deployment. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment). diff --git a/docs/repos/checkCollaborator.md b/docs/repos/checkCollaborator.md index b3e4af4e7..25b8d4c0e 100644 --- a/docs/repos/checkCollaborator.md +++ b/docs/repos/checkCollaborator.md @@ -12,9 +12,9 @@ For organization-owned repositories, the list of collaborators includes outside Team members will include the members of child teams. -You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this -endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this -endpoint. +The authenticated user must have push access to the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. ```js octokit.rest.repos.checkCollaborator({ diff --git a/docs/repos/compareCommitsWithBasehead.md b/docs/repos/compareCommitsWithBasehead.md index da8974907..0a219f93d 100644 --- a/docs/repos/compareCommitsWithBasehead.md +++ b/docs/repos/compareCommitsWithBasehead.md @@ -10,7 +10,12 @@ type: API method 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)." -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. You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. +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. + +This 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)." + +- **`application/vnd.github.diff`**: Returns the diff of the commit. +- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. The 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. @@ -85,12 +90,12 @@ The name of the repository without the `.git` extension. The name is not case se pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." baseheadyes diff --git a/docs/repos/createCommitComment.md b/docs/repos/createCommitComment.md index 003a95a53..e237ac88f 100644 --- a/docs/repos/createCommitComment.md +++ b/docs/repos/createCommitComment.md @@ -10,7 +10,14 @@ type: API method Create a comment for a commit using its `:commit_sha`. -This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.repos.createCommitComment({ diff --git a/docs/repos/createDeployment.md b/docs/repos/createDeployment.md index 5219c07fb..fc3367b94 100644 --- a/docs/repos/createDeployment.md +++ b/docs/repos/createDeployment.md @@ -34,8 +34,6 @@ The `task` parameter is used by the deployment system to allow different executi be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled. -Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. - Merged branch response: You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating @@ -58,6 +56,8 @@ Failed commit status checks: This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. +OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + ```js octokit.rest.repos.createDeployment({ owner, diff --git a/docs/repos/createDeploymentBranchPolicy.md b/docs/repos/createDeploymentBranchPolicy.md index eb91c2d62..fac45f9a9 100644 --- a/docs/repos/createDeploymentBranchPolicy.md +++ b/docs/repos/createDeploymentBranchPolicy.md @@ -10,7 +10,7 @@ type: API method Creates a deployment branch or tag policy for an environment. -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.createDeploymentBranchPolicy({ @@ -44,7 +44,7 @@ The name of the repository without the `.git` extension. The name is not case se environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. nameyes diff --git a/docs/repos/createDeploymentProtectionRule.md b/docs/repos/createDeploymentProtectionRule.md index 8f48b7f14..0eec78c65 100644 --- a/docs/repos/createDeploymentProtectionRule.md +++ b/docs/repos/createDeploymentProtectionRule.md @@ -10,10 +10,12 @@ type: API method Enable a custom deployment protection rule for an environment. -You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. +The authenticated user must have admin or owner permissions to the repository to use this endpoint. For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.repos.createDeploymentProtectionRule({ environment_name, @@ -35,7 +37,7 @@ octokit.rest.repos.createDeploymentProtectionRule({ environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. repoyes diff --git a/docs/repos/createDeploymentStatus.md b/docs/repos/createDeploymentStatus.md index 6ee2a79eb..19b2649fb 100644 --- a/docs/repos/createDeploymentStatus.md +++ b/docs/repos/createDeploymentStatus.md @@ -10,7 +10,7 @@ type: API method Users with `push` access can create deployment statuses for a given deployment. -GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. +OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. ```js octokit.rest.repos.createDeploymentStatus({ diff --git a/docs/repos/createDispatchEvent.md b/docs/repos/createDispatchEvent.md index bb6e83d31..c7290b396 100644 --- a/docs/repos/createDispatchEvent.md +++ b/docs/repos/createDispatchEvent.md @@ -12,13 +12,10 @@ You can use this endpoint to trigger a webhook event called `repository_dispatch The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. -This endpoint requires write access to the repository by providing either: - -- Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. -- GitHub Apps with both `metadata:read` and `contents:read&write` permissions. - This input example shows how you can use the `client_payload` as a test to debug your workflow. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.repos.createDispatchEvent({ owner, diff --git a/docs/repos/createForAuthenticatedUser.md b/docs/repos/createForAuthenticatedUser.md index 1b826c986..77b82d154 100644 --- a/docs/repos/createForAuthenticatedUser.md +++ b/docs/repos/createForAuthenticatedUser.md @@ -10,12 +10,7 @@ type: API method Creates a new repository for the authenticated user. -**OAuth scope requirements** - -When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - -- `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. -- `repo` scope to create a private repository. +OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. ```js octokit.rest.repos.createForAuthenticatedUser({ diff --git a/docs/repos/createInOrg.md b/docs/repos/createInOrg.md index f3b2f4b69..a487b80a0 100644 --- a/docs/repos/createInOrg.md +++ b/docs/repos/createInOrg.md @@ -10,12 +10,7 @@ type: API method Creates a new repository in the specified organization. The authenticated user must be a member of the organization. -**OAuth scope requirements** - -When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - -- `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. -- `repo` scope to create a private repository +OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. ```js octokit.rest.repos.createInOrg({ @@ -176,7 +171,7 @@ The default value for a merge commit message. custom_propertiesno -The custom properties for the new respository. The keys are the custom property names, and the values are the corresponding custom property values. +The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. custom_properties.*no diff --git a/docs/repos/createOrUpdateCustomPropertiesValues.md b/docs/repos/createOrUpdateCustomPropertiesValues.md new file mode 100644 index 000000000..c7f43f565 --- /dev/null +++ b/docs/repos/createOrUpdateCustomPropertiesValues.md @@ -0,0 +1,65 @@ +--- +name: Create or update custom property values for a repository +example: octokit.rest.repos.createOrUpdateCustomPropertiesValues({ owner, repo, properties, properties[].property_name, properties[].value }) +route: PATCH /repos/{owner}/{repo}/properties/values +scope: repos +type: API method +--- + +# Create or update custom property values for a repository + +Create new or update existing custom property values for a repository. +Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + +Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + +```js +octokit.rest.repos.createOrUpdateCustomPropertiesValues({ + owner, +repo, +properties, +properties[].property_name, +properties[].value + }) +``` + +## 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. + +
propertiesyes + +A list of custom property names and associated values to apply to the repositories. + +
properties[].property_nameyes + +The name of the property + +
properties[].valueyes + +The value assigned to the property + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository). diff --git a/docs/repos/createOrUpdateEnvironment.md b/docs/repos/createOrUpdateEnvironment.md index 0ce752014..8b83fd353 100644 --- a/docs/repos/createOrUpdateEnvironment.md +++ b/docs/repos/createOrUpdateEnvironment.md @@ -14,7 +14,7 @@ Create or update an environment with protection rules, such as required reviewer **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.createOrUpdateEnvironment({ @@ -49,7 +49,7 @@ The name of the repository without the `.git` extension. The name is not case se environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. wait_timerno diff --git a/docs/repos/createOrUpdateFileContents.md b/docs/repos/createOrUpdateFileContents.md index e86ba27a4..4163a97a5 100644 --- a/docs/repos/createOrUpdateFileContents.md +++ b/docs/repos/createOrUpdateFileContents.md @@ -8,10 +8,12 @@ type: API method # Create or update file contents -Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. +Creates a new file or replaces an existing file in a repository. **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. + ```js octokit.rest.repos.createOrUpdateFileContents({ owner, diff --git a/docs/repos/createPagesDeployment.md b/docs/repos/createPagesDeployment.md index b877aabd7..03c29edbb 100644 --- a/docs/repos/createPagesDeployment.md +++ b/docs/repos/createPagesDeployment.md @@ -1,7 +1,7 @@ --- name: Create a GitHub Pages deployment -example: octokit.rest.repos.createPagesDeployment({ owner, repo, artifact_url, pages_build_version, oidc_token }) -route: POST /repos/{owner}/{repo}/pages/deployment +example: octokit.rest.repos.createPagesDeployment({ owner, repo, pages_build_version, oidc_token }) +route: POST /repos/{owner}/{repo}/pages/deployments scope: repos type: API method --- @@ -10,13 +10,12 @@ type: API method Create a GitHub Pages deployment for a repository. -Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint. +The authenticated user must have write permission to the repository. ```js octokit.rest.repos.createPagesDeployment({ owner, repo, - artifact_url, pages_build_version, oidc_token, }); @@ -43,9 +42,14 @@ 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. -artifact_urlyes +artifact_idno -The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. +The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. + + +artifact_urlno + +The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. environmentno diff --git a/docs/repos/createPagesSite.md b/docs/repos/createPagesSite.md index 0432c8bde..22ae2dd3a 100644 --- a/docs/repos/createPagesSite.md +++ b/docs/repos/createPagesSite.md @@ -10,7 +10,9 @@ type: API method Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." -To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. +The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.createPagesSite({ diff --git a/docs/repos/createRelease.md b/docs/repos/createRelease.md index 801ee0e90..8042e7693 100644 --- a/docs/repos/createRelease.md +++ b/docs/repos/createRelease.md @@ -10,7 +10,7 @@ type: API method Users with push access to the repository can create a release. -This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." ```js octokit.rest.repos.createRelease({ diff --git a/docs/repos/createUsingTemplate.md b/docs/repos/createUsingTemplate.md index 2f65bded7..a36639481 100644 --- a/docs/repos/createUsingTemplate.md +++ b/docs/repos/createUsingTemplate.md @@ -10,12 +10,7 @@ type: API method Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. -**OAuth scope requirements** - -When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - -- `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. -- `repo` scope to create a private repository +OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. ```js octokit.rest.repos.createUsingTemplate({ diff --git a/docs/repos/createWebhook.md b/docs/repos/createWebhook.md index cac754913..ba7b17649 100644 --- a/docs/repos/createWebhook.md +++ b/docs/repos/createWebhook.md @@ -66,12 +66,6 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig config.insecure_sslno - -config.tokenno - - -config.digestno - eventsno diff --git a/docs/repos/delete.md b/docs/repos/delete.md index ed9636514..af13e0013 100644 --- a/docs/repos/delete.md +++ b/docs/repos/delete.md @@ -8,11 +8,13 @@ type: API method # Delete a repository -Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. +Deleting a repository requires admin access. If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, you will get a `403 Forbidden` response. +OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. + ```js octokit.rest.repos.delete({ owner, diff --git a/docs/repos/deleteAnEnvironment.md b/docs/repos/deleteAnEnvironment.md index 7ba102c1b..c1b9efd20 100644 --- a/docs/repos/deleteAnEnvironment.md +++ b/docs/repos/deleteAnEnvironment.md @@ -8,7 +8,7 @@ type: API method # Delete an environment -You must authenticate using an access token with the repo scope to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.deleteAnEnvironment({ @@ -41,7 +41,7 @@ The name of the repository without the `.git` extension. The name is not case se environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. diff --git a/docs/repos/deleteDeployment.md b/docs/repos/deleteDeployment.md index f17649cb6..226f28eee 100644 --- a/docs/repos/deleteDeployment.md +++ b/docs/repos/deleteDeployment.md @@ -8,7 +8,7 @@ type: API method # Delete a deployment -If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. +If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. To set a deployment as inactive, you must: @@ -17,6 +17,8 @@ To set a deployment as inactive, you must: For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." +OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + ```js octokit.rest.repos.deleteDeployment({ owner, diff --git a/docs/repos/deleteDeploymentBranchPolicy.md b/docs/repos/deleteDeploymentBranchPolicy.md index 4b60a6de4..a09c4e535 100644 --- a/docs/repos/deleteDeploymentBranchPolicy.md +++ b/docs/repos/deleteDeploymentBranchPolicy.md @@ -10,7 +10,7 @@ type: API method Deletes a deployment branch or tag policy for an environment. -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.deleteDeploymentBranchPolicy({ @@ -44,7 +44,7 @@ The name of the repository without the `.git` extension. The name is not case se environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. branch_policy_idyes diff --git a/docs/repos/deletePagesSite.md b/docs/repos/deletePagesSite.md index f327061c5..138106f85 100644 --- a/docs/repos/deletePagesSite.md +++ b/docs/repos/deletePagesSite.md @@ -10,7 +10,9 @@ type: API method Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). -To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. +The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.deletePagesSite({ diff --git a/docs/repos/disableDeploymentProtectionRule.md b/docs/repos/disableDeploymentProtectionRule.md index e027c13fe..db0618a08 100644 --- a/docs/repos/disableDeploymentProtectionRule.md +++ b/docs/repos/disableDeploymentProtectionRule.md @@ -10,7 +10,9 @@ type: API method Disables a custom deployment protection rule for an environment. -You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)". +The authenticated user must have admin or owner permissions to the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.disableDeploymentProtectionRule({ @@ -34,7 +36,7 @@ octokit.rest.repos.disableDeploymentProtectionRule({ environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. repoyes diff --git a/docs/repos/getAllDeploymentProtectionRules.md b/docs/repos/getAllDeploymentProtectionRules.md index fc30478b3..85b62b861 100644 --- a/docs/repos/getAllDeploymentProtectionRules.md +++ b/docs/repos/getAllDeploymentProtectionRules.md @@ -8,10 +8,12 @@ type: API method # Get all deployment protection rules for an environment -Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." +Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + ```js octokit.rest.repos.getAllDeploymentProtectionRules({ environment_name, @@ -33,7 +35,7 @@ octokit.rest.repos.getAllDeploymentProtectionRules({ environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. repoyes diff --git a/docs/repos/getAllEnvironments.md b/docs/repos/getAllEnvironments.md index 86063003c..55f245624 100644 --- a/docs/repos/getAllEnvironments.md +++ b/docs/repos/getAllEnvironments.md @@ -10,7 +10,9 @@ type: API method Lists the environments for a repository. -Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +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. ```js octokit.rest.repos.getAllEnvironments({ @@ -42,12 +44,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/getAllTopics.md b/docs/repos/getAllTopics.md index a3a1e35cb..1b9c51d25 100644 --- a/docs/repos/getAllTopics.md +++ b/docs/repos/getAllTopics.md @@ -38,12 +38,12 @@ The name of the repository without the `.git` extension. The name is not case se pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/getAppsWithAccessToProtectedBranch.md b/docs/repos/getAppsWithAccessToProtectedBranch.md index 747dfc500..989d9560e 100644 --- a/docs/repos/getAppsWithAccessToProtectedBranch.md +++ b/docs/repos/getAppsWithAccessToProtectedBranch.md @@ -10,7 +10,7 @@ type: API method Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. -Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. +Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. ```js octokit.rest.repos.getAppsWithAccessToProtectedBranch({ diff --git a/docs/repos/getBranchRules.md b/docs/repos/getBranchRules.md index 148cb9897..a5777fa5e 100644 --- a/docs/repos/getBranchRules.md +++ b/docs/repos/getBranchRules.md @@ -49,12 +49,12 @@ The name of the branch. Cannot contain wildcard characters. To use wildcard char per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/getCodeFrequencyStats.md b/docs/repos/getCodeFrequencyStats.md index b6a0f3f12..d258f5794 100644 --- a/docs/repos/getCodeFrequencyStats.md +++ b/docs/repos/getCodeFrequencyStats.md @@ -10,6 +10,9 @@ type: API method Returns a weekly aggregate of the number of additions and deletions pushed to a repository. +**Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains +10,000 or more commits, a 422 status code will be returned. + ```js octokit.rest.repos.getCodeFrequencyStats({ owner, diff --git a/docs/repos/getCombinedStatusForRef.md b/docs/repos/getCombinedStatusForRef.md index 988288e37..e47b252cc 100644 --- a/docs/repos/getCombinedStatusForRef.md +++ b/docs/repos/getCombinedStatusForRef.md @@ -52,12 +52,12 @@ The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/getCommit.md b/docs/repos/getCommit.md index 79936cd05..953564c19 100644 --- a/docs/repos/getCommit.md +++ b/docs/repos/getCommit.md @@ -10,11 +10,13 @@ type: API method Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. -**Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. +**Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. -You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. +This 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)." Pagination query parameters are not supported for these media types. -To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. +- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. +- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. +- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. **Signature verification object** @@ -76,12 +78,12 @@ The name of the repository without the `.git` extension. The name is not case se pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." refyes diff --git a/docs/repos/getCommitComment.md b/docs/repos/getCommitComment.md index 4805fa13d..d707fe682 100644 --- a/docs/repos/getCommitComment.md +++ b/docs/repos/getCommitComment.md @@ -8,6 +8,15 @@ type: API method # Get a commit comment +Gets a specified commit comment. + +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.repos.getCommitComment({ owner, diff --git a/docs/repos/getContent.md b/docs/repos/getContent.md index ca158c37a..a4dff7146 100644 --- a/docs/repos/getContent.md +++ b/docs/repos/getContent.md @@ -8,44 +8,31 @@ type: API method # Get repository content -Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit -`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. +Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. -Files and symlinks support [a custom media type](https://docs.github.com/rest/overview/media-types) for -retrieving the raw content or rendered HTML (when supported). All content types support [a custom media -type](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent -object format. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. +- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). +- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + +If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". + +If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + +If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. **Notes**: - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). -- This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees - API](https://docs.github.com/rest/git/trees#get-a-tree). +- This API has an upper limit of 1,000 files for a directory. If you need to retrieve + more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - Size limits: - If the requested file's size is: -- 1 MB or smaller: All features of this endpoint are supported. -- Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. -- Greater than 100 MB: This endpoint is not supported. - -If the content is a directory: -The response will be an array of objects, one object for each item in the directory. -When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value -_should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). -In the next major version of the API, the type will be returned as "submodule". - -If the content is a symlink: -If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the -API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object -describing the symlink itself. - -If the content is a submodule: -The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific -commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out -the submodule at that specific commit. - -If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the -github.com URLs (`html_url` and `_links["html"]`) will have null values. +- If the requested file's size is: + - 1 MB or smaller: All features of this endpoint are supported. + - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + - Greater than 100 MB: This endpoint is not supported. ```js octokit.rest.repos.getContent({ diff --git a/docs/repos/getContributorsStats.md b/docs/repos/getContributorsStats.md index 6a932d358..9a4c1c3d0 100644 --- a/docs/repos/getContributorsStats.md +++ b/docs/repos/getContributorsStats.md @@ -10,11 +10,13 @@ type: API method Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: -- `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). +- `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - `a` - Number of additions - `d` - Number of deletions - `c` - Number of commits +**Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + ```js octokit.rest.repos.getContributorsStats({ owner, diff --git a/docs/repos/getCustomDeploymentProtectionRule.md b/docs/repos/getCustomDeploymentProtectionRule.md index 56001e3b2..84d14f6fb 100644 --- a/docs/repos/getCustomDeploymentProtectionRule.md +++ b/docs/repos/getCustomDeploymentProtectionRule.md @@ -8,10 +8,12 @@ type: API method # Get a custom deployment protection rule -Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." +Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + ```js octokit.rest.repos.getCustomDeploymentProtectionRule({ owner, @@ -44,7 +46,7 @@ The name of the repository without the `.git` extension. The name is not case se environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. protection_rule_idyes diff --git a/docs/repos/getDeploymentBranchPolicy.md b/docs/repos/getDeploymentBranchPolicy.md index 80dbf48ae..56ceb5b5d 100644 --- a/docs/repos/getDeploymentBranchPolicy.md +++ b/docs/repos/getDeploymentBranchPolicy.md @@ -10,7 +10,9 @@ type: API method Gets a deployment branch or tag policy for an environment. -Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +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. ```js octokit.rest.repos.getDeploymentBranchPolicy({ @@ -44,7 +46,7 @@ The name of the repository without the `.git` extension. The name is not case se environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. branch_policy_idyes diff --git a/docs/repos/getEnvironment.md b/docs/repos/getEnvironment.md index 9905ae9ac..62dc2a195 100644 --- a/docs/repos/getEnvironment.md +++ b/docs/repos/getEnvironment.md @@ -10,9 +10,9 @@ type: API method **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." -Anyone with read access to the repository can use this endpoint. If the -repository is private, you must use an access token with the `repo` scope. GitHub -Apps must have the `actions:read` permission to use this endpoint. +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. ```js octokit.rest.repos.getEnvironment({ @@ -45,7 +45,7 @@ The name of the repository without the `.git` extension. The name is not case se environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. diff --git a/docs/repos/getLatestPagesBuild.md b/docs/repos/getLatestPagesBuild.md index 52159f764..87fb4e462 100644 --- a/docs/repos/getLatestPagesBuild.md +++ b/docs/repos/getLatestPagesBuild.md @@ -10,7 +10,7 @@ type: API method Gets information about the single most recent build of a GitHub Pages site. -A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.getLatestPagesBuild({ diff --git a/docs/repos/getOrgRuleSuites.md b/docs/repos/getOrgRuleSuites.md index 0d4c5ff97..5c494c87d 100644 --- a/docs/repos/getOrgRuleSuites.md +++ b/docs/repos/getOrgRuleSuites.md @@ -57,12 +57,12 @@ The rule results to filter on. When specified, only suites with this result will per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/getOrgRulesets.md b/docs/repos/getOrgRulesets.md index 66a82cc45..a52bdef82 100644 --- a/docs/repos/getOrgRulesets.md +++ b/docs/repos/getOrgRulesets.md @@ -34,12 +34,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/getPages.md b/docs/repos/getPages.md index ea239939c..09157191d 100644 --- a/docs/repos/getPages.md +++ b/docs/repos/getPages.md @@ -10,7 +10,7 @@ type: API method Gets information about a GitHub Pages site. -A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.getPages({ diff --git a/docs/repos/getPagesBuild.md b/docs/repos/getPagesBuild.md index 0a3bbac98..4ca9dc45c 100644 --- a/docs/repos/getPagesBuild.md +++ b/docs/repos/getPagesBuild.md @@ -10,7 +10,7 @@ type: API method Gets information about a GitHub Pages build. -A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.getPagesBuild({ diff --git a/docs/repos/getPagesDeployment.md b/docs/repos/getPagesDeployment.md new file mode 100644 index 000000000..f247c2b7f --- /dev/null +++ b/docs/repos/getPagesDeployment.md @@ -0,0 +1,52 @@ +--- +name: Get the status of a GitHub Pages deployment +example: octokit.rest.repos.getPagesDeployment({ owner, repo, pages_deployment_id }) +route: GET /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id} +scope: repos +type: API method +--- + +# Get the status of a GitHub Pages deployment + +Gets the current status of a GitHub Pages deployment. + +The authenticated user must have read permission for the GitHub Pages site. + +```js +octokit.rest.repos.getPagesDeployment({ + owner, + repo, + pages_deployment_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. + +
pages_deployment_idyes + +The ID of the Pages deployment. You can also give the commit SHA of the deployment. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment). diff --git a/docs/repos/getPagesHealthCheck.md b/docs/repos/getPagesHealthCheck.md index fa2470921..312576e76 100644 --- a/docs/repos/getPagesHealthCheck.md +++ b/docs/repos/getPagesHealthCheck.md @@ -12,7 +12,9 @@ Gets a health check of the DNS settings for the `CNAME` record configured for a The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. -To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions. +The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.getPagesHealthCheck({ diff --git a/docs/repos/getReadme.md b/docs/repos/getReadme.md index 5be2ddd5a..cfbd73d67 100644 --- a/docs/repos/getReadme.md +++ b/docs/repos/getReadme.md @@ -10,7 +10,10 @@ type: API method Gets the preferred README for a repository. -READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. +- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). ```js octokit.rest.repos.getReadme({ diff --git a/docs/repos/getReadmeInDirectory.md b/docs/repos/getReadmeInDirectory.md index c883b0d1d..b5ea2e30e 100644 --- a/docs/repos/getReadmeInDirectory.md +++ b/docs/repos/getReadmeInDirectory.md @@ -10,7 +10,10 @@ type: API method Gets the README from a repository directory. -READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. +This 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)." + +- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. +- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). ```js octokit.rest.repos.getReadmeInDirectory({ diff --git a/docs/repos/getRelease.md b/docs/repos/getRelease.md index 8909cff15..781fa60c2 100644 --- a/docs/repos/getRelease.md +++ b/docs/repos/getRelease.md @@ -8,7 +8,11 @@ type: API method # Get a release -**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). +Gets a public release with the specified release ID. + +**Note:** This returns an `upload_url` key corresponding to the endpoint +for uploading release assets. This key is a hypermedia resource. For more information, see +"[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." ```js octokit.rest.repos.getRelease({ diff --git a/docs/repos/getRepoRuleSuites.md b/docs/repos/getRepoRuleSuites.md index aeeda89cc..13d1ee3b6 100644 --- a/docs/repos/getRepoRuleSuites.md +++ b/docs/repos/getRepoRuleSuites.md @@ -63,12 +63,12 @@ The rule results to filter on. When specified, only suites with this result will per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/getRepoRulesets.md b/docs/repos/getRepoRulesets.md index 3c114e989..cfffee9e9 100644 --- a/docs/repos/getRepoRulesets.md +++ b/docs/repos/getRepoRulesets.md @@ -40,12 +40,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." includes_parentsno diff --git a/docs/repos/getWebhookConfigForRepo.md b/docs/repos/getWebhookConfigForRepo.md index c5e995fbd..5c9794221 100644 --- a/docs/repos/getWebhookConfigForRepo.md +++ b/docs/repos/getWebhookConfigForRepo.md @@ -10,7 +10,7 @@ type: API method Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." -Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. +OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. ```js octokit.rest.repos.getWebhookConfigForRepo({ diff --git a/docs/repos/listActivities.md b/docs/repos/listActivities.md index 66a19fbfa..7eeb87956 100644 --- a/docs/repos/listActivities.md +++ b/docs/repos/listActivities.md @@ -48,17 +48,17 @@ The direction to sort the results by. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." beforeno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." afterno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." refno diff --git a/docs/repos/listAutolinks.md b/docs/repos/listAutolinks.md index 6c4a397b5..ea322634b 100644 --- a/docs/repos/listAutolinks.md +++ b/docs/repos/listAutolinks.md @@ -1,14 +1,14 @@ --- -name: List all autolinks of a repository +name: Get all autolinks of a repository example: octokit.rest.repos.listAutolinks({ owner, repo }) route: GET /repos/{owner}/{repo}/autolinks scope: repos type: API method --- -# List all autolinks of a repository +# Get all autolinks of a repository -This returns a list of autolinks configured for the given repository. +Gets all autolinks that are configured for a repository. Information about autolinks are only available to repository administrators. @@ -39,13 +39,8 @@ 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. - -pageno - -Page number of the results to fetch. - -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/autolinks#list-all-autolinks-of-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository). diff --git a/docs/repos/listBranches.md b/docs/repos/listBranches.md index 6b3920f29..84831bf14 100644 --- a/docs/repos/listBranches.md +++ b/docs/repos/listBranches.md @@ -43,12 +43,12 @@ Setting to `true` returns only protected branches. When set to `false`, only unp per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listCollaborators.md b/docs/repos/listCollaborators.md index ff6ef946b..bef3a9049 100644 --- a/docs/repos/listCollaborators.md +++ b/docs/repos/listCollaborators.md @@ -13,9 +13,9 @@ Organization members with write, maintain, or admin privileges on the organizati Team members will include the members of child teams. -You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this -endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this -endpoint. +The authenticated user must have push access to the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. ```js octokit.rest.repos.listCollaborators({ @@ -57,12 +57,12 @@ Filter collaborators by the permissions they have on the repository. If not spec per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listCommentsForCommit.md b/docs/repos/listCommentsForCommit.md index 43984c13a..a3e651246 100644 --- a/docs/repos/listCommentsForCommit.md +++ b/docs/repos/listCommentsForCommit.md @@ -8,7 +8,14 @@ type: API method # List commit comments -Use the `:commit_sha` to specify the commit that will have its comments listed. +Lists the comments for a specified commit. + +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.repos.listCommentsForCommit({ @@ -46,12 +53,12 @@ The SHA of the commit. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listCommitCommentsForRepo.md b/docs/repos/listCommitCommentsForRepo.md index ff51468ba..061f20e55 100644 --- a/docs/repos/listCommitCommentsForRepo.md +++ b/docs/repos/listCommitCommentsForRepo.md @@ -8,9 +8,14 @@ type: API method # List commit comments for a repository -Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). +Lists the commit comments for a specified repository. Comments are ordered by ascending ID. -Comments are ordered by ascending ID. +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. ```js octokit.rest.repos.listCommitCommentsForRepo({ @@ -42,12 +47,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listCommitStatusesForRef.md b/docs/repos/listCommitStatusesForRef.md index d55107fa1..792eb46ec 100644 --- a/docs/repos/listCommitStatusesForRef.md +++ b/docs/repos/listCommitStatusesForRef.md @@ -48,12 +48,12 @@ The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listCommits.md b/docs/repos/listCommits.md index c09cac82a..f927fc370 100644 --- a/docs/repos/listCommits.md +++ b/docs/repos/listCommits.md @@ -97,12 +97,12 @@ Only commits before this date will be returned. This is a timestamp in [ISO 8601 per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listContributors.md b/docs/repos/listContributors.md index 34c71d476..5b82e457e 100644 --- a/docs/repos/listContributors.md +++ b/docs/repos/listContributors.md @@ -47,12 +47,12 @@ Set to `1` or `true` to include anonymous contributors in results. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listCustomDeploymentRuleIntegrations.md b/docs/repos/listCustomDeploymentRuleIntegrations.md index b31e963f2..4c2b932be 100644 --- a/docs/repos/listCustomDeploymentRuleIntegrations.md +++ b/docs/repos/listCustomDeploymentRuleIntegrations.md @@ -8,12 +8,14 @@ type: API method # List custom deployment rule integrations available for an environment -Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. +Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. -For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." +For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + ```js octokit.rest.repos.listCustomDeploymentRuleIntegrations({ environment_name, @@ -35,7 +37,7 @@ octokit.rest.repos.listCustomDeploymentRuleIntegrations({ environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. repoyes @@ -50,12 +52,12 @@ The account owner of the repository. The name is not case sensitive. pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listDeployKeys.md b/docs/repos/listDeployKeys.md index 9cacb9f95..8ce50e20e 100644 --- a/docs/repos/listDeployKeys.md +++ b/docs/repos/listDeployKeys.md @@ -38,12 +38,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listDeploymentBranchPolicies.md b/docs/repos/listDeploymentBranchPolicies.md index 9616ab25d..7fb702c47 100644 --- a/docs/repos/listDeploymentBranchPolicies.md +++ b/docs/repos/listDeploymentBranchPolicies.md @@ -10,7 +10,9 @@ type: API method Lists the deployment branch policies for an environment. -Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. +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. ```js octokit.rest.repos.listDeploymentBranchPolicies({ @@ -43,17 +45,17 @@ The name of the repository without the `.git` extension. The name is not case se environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listDeploymentStatuses.md b/docs/repos/listDeploymentStatuses.md index df10dcaf0..b8742f65b 100644 --- a/docs/repos/listDeploymentStatuses.md +++ b/docs/repos/listDeploymentStatuses.md @@ -46,12 +46,12 @@ deployment_id parameter per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listDeployments.md b/docs/repos/listDeployments.md index 8bfaf750c..f1e9838c5 100644 --- a/docs/repos/listDeployments.md +++ b/docs/repos/listDeployments.md @@ -60,12 +60,12 @@ The name of the environment that was deployed to (e.g., `staging` or `production per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listForAuthenticatedUser.md b/docs/repos/listForAuthenticatedUser.md index dfcb4d53c..a74399d47 100644 --- a/docs/repos/listForAuthenticatedUser.md +++ b/docs/repos/listForAuthenticatedUser.md @@ -58,12 +58,12 @@ The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." sinceno diff --git a/docs/repos/listForOrg.md b/docs/repos/listForOrg.md index 3bc1b8c0a..1f2f92547 100644 --- a/docs/repos/listForOrg.md +++ b/docs/repos/listForOrg.md @@ -51,12 +51,12 @@ The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listForUser.md b/docs/repos/listForUser.md index 4dcc5b159..17876d006 100644 --- a/docs/repos/listForUser.md +++ b/docs/repos/listForUser.md @@ -8,7 +8,7 @@ type: API method # List repositories for a user -Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. +Lists public repositories for the specified user. ```js octokit.rest.repos.listForUser({ @@ -49,12 +49,12 @@ The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listForks.md b/docs/repos/listForks.md index 40839d7bc..a844d2f7e 100644 --- a/docs/repos/listForks.md +++ b/docs/repos/listForks.md @@ -43,12 +43,12 @@ The sort order. `stargazers` will sort by star count. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listInvitations.md b/docs/repos/listInvitations.md index c7c6a55fd..d30cd2068 100644 --- a/docs/repos/listInvitations.md +++ b/docs/repos/listInvitations.md @@ -40,12 +40,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listInvitationsForAuthenticatedUser.md b/docs/repos/listInvitationsForAuthenticatedUser.md index adcd67503..7904b01e7 100644 --- a/docs/repos/listInvitationsForAuthenticatedUser.md +++ b/docs/repos/listInvitationsForAuthenticatedUser.md @@ -27,12 +27,12 @@ octokit.rest.repos.listInvitationsForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listPagesBuilds.md b/docs/repos/listPagesBuilds.md index 10e004450..aa71fc6c1 100644 --- a/docs/repos/listPagesBuilds.md +++ b/docs/repos/listPagesBuilds.md @@ -10,7 +10,7 @@ type: API method Lists builts of a GitHub Pages site. -A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.listPagesBuilds({ @@ -42,12 +42,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listPullRequestsAssociatedWithCommit.md b/docs/repos/listPullRequestsAssociatedWithCommit.md index 89d44edd7..fc52f1aee 100644 --- a/docs/repos/listPullRequestsAssociatedWithCommit.md +++ b/docs/repos/listPullRequestsAssociatedWithCommit.md @@ -48,12 +48,12 @@ The SHA of the commit. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listReleaseAssets.md b/docs/repos/listReleaseAssets.md index 0be348ad1..73028e603 100644 --- a/docs/repos/listReleaseAssets.md +++ b/docs/repos/listReleaseAssets.md @@ -44,12 +44,12 @@ The unique identifier of the release. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listReleases.md b/docs/repos/listReleases.md index 082742b3d..d8cedb784 100644 --- a/docs/repos/listReleases.md +++ b/docs/repos/listReleases.md @@ -42,12 +42,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listTags.md b/docs/repos/listTags.md index 5e439ba99..bdba705f3 100644 --- a/docs/repos/listTags.md +++ b/docs/repos/listTags.md @@ -38,12 +38,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listTeams.md b/docs/repos/listTeams.md index 1a72c4287..ad60b9944 100644 --- a/docs/repos/listTeams.md +++ b/docs/repos/listTeams.md @@ -12,12 +12,7 @@ Lists the teams that have access to the specified repository and that are also v For a public repository, a team is listed only if that team added the public repository explicitly. -Personal access tokens require the following scopes: - -- `public_repo` to call this endpoint on a public repository -- `repo` to call this endpoint on a private repository (this scope also includes public repositories) - -This endpoint is not compatible with fine-grained personal access tokens. +OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. ```js octokit.rest.repos.listTeams({ @@ -49,12 +44,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/listWebhookDeliveries.md b/docs/repos/listWebhookDeliveries.md index 9729b9cfd..2b122a9e1 100644 --- a/docs/repos/listWebhookDeliveries.md +++ b/docs/repos/listWebhookDeliveries.md @@ -46,7 +46,7 @@ The unique identifier of the hook. You can find this value in the `X-GitHub-Hook per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." cursorno diff --git a/docs/repos/listWebhooks.md b/docs/repos/listWebhooks.md index f138c83c5..57401c7c6 100644 --- a/docs/repos/listWebhooks.md +++ b/docs/repos/listWebhooks.md @@ -40,12 +40,12 @@ The name of the repository without the `.git` extension. The name is not case se per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/repos/removeAppAccessRestrictions.md b/docs/repos/removeAppAccessRestrictions.md index cefeda0b1..90ff4a061 100644 --- a/docs/repos/removeAppAccessRestrictions.md +++ b/docs/repos/removeAppAccessRestrictions.md @@ -10,7 +10,7 @@ type: API method Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. -Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. +Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. ```js octokit.rest.repos.removeAppAccessRestrictions({ diff --git a/docs/repos/renameBranch.md b/docs/repos/renameBranch.md index b9b538b63..12b6cba98 100644 --- a/docs/repos/renameBranch.md +++ b/docs/repos/renameBranch.md @@ -12,17 +12,9 @@ Renames a branch in a repository. **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". -The permissions required to use this endpoint depends on whether you are renaming the default branch. +The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. -To rename a non-default branch: - -- Users must have push access. -- GitHub Apps must have the `contents:write` repository permission. - -To rename the default branch: - -- Users must have admin or owner permissions. -- GitHub Apps must have the `administration:write` repository permission. +In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. ```js octokit.rest.repos.renameBranch({ diff --git a/docs/repos/setAppAccessRestrictions.md b/docs/repos/setAppAccessRestrictions.md index 61fae2519..6f0b83817 100644 --- a/docs/repos/setAppAccessRestrictions.md +++ b/docs/repos/setAppAccessRestrictions.md @@ -10,7 +10,7 @@ type: API method Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. -Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. +Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. ```js octokit.rest.repos.setAppAccessRestrictions({ diff --git a/docs/repos/transfer.md b/docs/repos/transfer.md index f0abdaf7d..8fc765281 100644 --- a/docs/repos/transfer.md +++ b/docs/repos/transfer.md @@ -9,7 +9,6 @@ type: API method # Transfer a repository A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). -You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. ```js octokit.rest.repos.transfer({ diff --git a/docs/repos/updateCommitComment.md b/docs/repos/updateCommitComment.md index 6a5f95c50..3ec0ed12a 100644 --- a/docs/repos/updateCommitComment.md +++ b/docs/repos/updateCommitComment.md @@ -8,6 +8,15 @@ type: API method # Update a commit comment +Updates the contents of a specified commit comment. + +This 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)." + +- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. +- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. +- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. +- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + ```js octokit.rest.repos.updateCommitComment({ owner, diff --git a/docs/repos/updateDeploymentBranchPolicy.md b/docs/repos/updateDeploymentBranchPolicy.md index 9752a066c..775083ee1 100644 --- a/docs/repos/updateDeploymentBranchPolicy.md +++ b/docs/repos/updateDeploymentBranchPolicy.md @@ -10,7 +10,7 @@ type: API method Updates a deployment branch or tag policy for an environment. -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.updateDeploymentBranchPolicy({ @@ -45,7 +45,7 @@ The name of the repository without the `.git` extension. The name is not case se environment_nameyes -The name of the environment. +The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. branch_policy_idyes diff --git a/docs/repos/updateInformationAboutPagesSite.md b/docs/repos/updateInformationAboutPagesSite.md index 0784545ff..34df38e19 100644 --- a/docs/repos/updateInformationAboutPagesSite.md +++ b/docs/repos/updateInformationAboutPagesSite.md @@ -10,7 +10,9 @@ type: API method Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). -To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. +The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.repos.updateInformationAboutPagesSite({ diff --git a/docs/repos/updateWebhook.md b/docs/repos/updateWebhook.md index e3ba8e1d1..383dfb528 100644 --- a/docs/repos/updateWebhook.md +++ b/docs/repos/updateWebhook.md @@ -1,6 +1,6 @@ --- name: Update a repository webhook -example: octokit.rest.repos.updateWebhook({ owner, repo, hook_id, config.url }) +example: octokit.rest.repos.updateWebhook({ owner, repo, hook_id }) route: PATCH /repos/{owner}/{repo}/hooks/{hook_id} scope: repos type: API method @@ -12,11 +12,10 @@ Updates a webhook configured in a repository. If you previously had a `secret` s ```js octokit.rest.repos.updateWebhook({ - owner, -repo, -hook_id, -config.url - }) + owner, + repo, + hook_id, +}); ``` ## Parameters @@ -47,10 +46,10 @@ The unique identifier of the hook. You can find this value in the `X-GitHub-Hook configno -Key/value pairs to provide settings for this webhook. +Configuration object of the webhook -config.urlyes +config.urlno The URL to which the payloads will be delivered. @@ -67,12 +66,6 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig config.insecure_sslno - -config.addressno - - -config.roomno - eventsno diff --git a/docs/repos/updateWebhookConfigForRepo.md b/docs/repos/updateWebhookConfigForRepo.md index f1fd92507..7070edb86 100644 --- a/docs/repos/updateWebhookConfigForRepo.md +++ b/docs/repos/updateWebhookConfigForRepo.md @@ -10,7 +10,7 @@ type: API method Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." -Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. +OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. ```js octokit.rest.repos.updateWebhookConfigForRepo({ diff --git a/docs/repos/uploadReleaseAsset.md b/docs/repos/uploadReleaseAsset.md index a7f27752e..950c53406 100644 --- a/docs/repos/uploadReleaseAsset.md +++ b/docs/repos/uploadReleaseAsset.md @@ -8,7 +8,7 @@ type: API method # Upload a release asset -This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in +This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset. You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. diff --git a/docs/search/code.md b/docs/search/code.md index 3724c705f..7ae57a4e5 100644 --- a/docs/search/code.md +++ b/docs/search/code.md @@ -8,7 +8,7 @@ type: API method # Search code -Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). +Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -63,12 +63,12 @@ The query contains one or more search keywords and qualifiers. Qualifiers allow per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/search/commits.md b/docs/search/commits.md index 9b6d552f2..65f9ab2e4 100644 --- a/docs/search/commits.md +++ b/docs/search/commits.md @@ -8,7 +8,7 @@ type: API method # Search commits -Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). +Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -51,12 +51,12 @@ Determines whether the first search result returned is the highest number of mat per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/search/issuesAndPullRequests.md b/docs/search/issuesAndPullRequests.md index 4aefe5605..d456aafc7 100644 --- a/docs/search/issuesAndPullRequests.md +++ b/docs/search/issuesAndPullRequests.md @@ -8,7 +8,7 @@ type: API method # Search issues and pull requests -Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). +Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -55,12 +55,12 @@ Determines whether the first search result returned is the highest number of mat per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/search/labels.md b/docs/search/labels.md index 210d49680..13204f229 100644 --- a/docs/search/labels.md +++ b/docs/search/labels.md @@ -8,7 +8,7 @@ type: API method # Search labels -Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). +Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -58,12 +58,12 @@ Determines whether the first search result returned is the highest number of mat per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/search/repos.md b/docs/search/repos.md index 7df4cc1d9..733212eda 100644 --- a/docs/search/repos.md +++ b/docs/search/repos.md @@ -8,7 +8,7 @@ type: API method # Search repositories -Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). +Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -52,12 +52,12 @@ Determines whether the first search result returned is the highest number of mat per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/search/topics.md b/docs/search/topics.md index c99705237..e8b7e458a 100644 --- a/docs/search/topics.md +++ b/docs/search/topics.md @@ -8,7 +8,7 @@ type: API method # Search topics -Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. +Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. When searching for topics, you can get text match metadata for the topic's **short_description**, **description**, **name**, or **display_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -42,12 +42,12 @@ The query contains one or more search keywords and qualifiers. Qualifiers allow per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/search/users.md b/docs/search/users.md index 7756ad311..e9ef52dfb 100644 --- a/docs/search/users.md +++ b/docs/search/users.md @@ -8,7 +8,7 @@ type: API method # Search users -Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). +Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -54,12 +54,12 @@ Determines whether the first search result returned is the highest number of mat per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/secretScanning/getAlert.md b/docs/secretScanning/getAlert.md index 0fa006965..53460c0ea 100644 --- a/docs/secretScanning/getAlert.md +++ b/docs/secretScanning/getAlert.md @@ -9,10 +9,10 @@ type: API method # Get a secret scanning alert Gets a single secret scanning alert detected in an eligible repository. -To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. -For public repositories, you may instead use the `public_repo` scope. -GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. +The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. ```js octokit.rest.secretScanning.getAlert({ diff --git a/docs/secretScanning/listAlertsForEnterprise.md b/docs/secretScanning/listAlertsForEnterprise.md index 7255ad4e0..1053bc24e 100644 --- a/docs/secretScanning/listAlertsForEnterprise.md +++ b/docs/secretScanning/listAlertsForEnterprise.md @@ -9,7 +9,12 @@ type: API method # List secret scanning alerts for an enterprise Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. -To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + +Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + +The authenticated user must be a member of the enterprise in order to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. ```js octokit.rest.secretScanning.listAlertsForEnterprise({ @@ -62,17 +67,17 @@ The direction to sort the results by. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." beforeno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." afterno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." validityno diff --git a/docs/secretScanning/listAlertsForOrg.md b/docs/secretScanning/listAlertsForOrg.md index f161f14df..6030cbd19 100644 --- a/docs/secretScanning/listAlertsForOrg.md +++ b/docs/secretScanning/listAlertsForOrg.md @@ -9,10 +9,10 @@ type: API method # List secret scanning alerts for an organization Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. -To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. -For public repositories, you may instead use the `public_repo` scope. -GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. +The authenticated user must be an administrator or security manager for the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. ```js octokit.rest.secretScanning.listAlertsForOrg({ @@ -65,12 +65,12 @@ The direction to sort the results by. pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." beforeno diff --git a/docs/secretScanning/listAlertsForRepo.md b/docs/secretScanning/listAlertsForRepo.md index f1a874618..e2acc482f 100644 --- a/docs/secretScanning/listAlertsForRepo.md +++ b/docs/secretScanning/listAlertsForRepo.md @@ -9,10 +9,10 @@ type: API method # List secret scanning alerts for a repository Lists secret scanning alerts for an eligible repository, from newest to oldest. -To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. -For public repositories, you may instead use the `public_repo` scope. -GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. +The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. ```js octokit.rest.secretScanning.listAlertsForRepo({ @@ -71,12 +71,12 @@ The direction to sort the results by. pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." beforeno diff --git a/docs/secretScanning/listLocationsForAlert.md b/docs/secretScanning/listLocationsForAlert.md index 7b9443a68..af8ad0372 100644 --- a/docs/secretScanning/listLocationsForAlert.md +++ b/docs/secretScanning/listLocationsForAlert.md @@ -9,10 +9,10 @@ type: API method # List locations for a secret scanning alert Lists all locations for a given secret scanning alert for an eligible repository. -To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. -For public repositories, you may instead use the `public_repo` scope. -GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. +The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. ```js octokit.rest.secretScanning.listLocationsForAlert({ @@ -50,12 +50,12 @@ The number that identifies an alert. You can find this at the end of the URL for pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/secretScanning/updateAlert.md b/docs/secretScanning/updateAlert.md index 751bca9e5..29fdb820a 100644 --- a/docs/secretScanning/updateAlert.md +++ b/docs/secretScanning/updateAlert.md @@ -9,10 +9,10 @@ type: API method # Update a secret scanning alert Updates the status of a secret scanning alert in an eligible repository. -To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. -For public repositories, you may instead use the `public_repo` scope. -GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. +The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. ```js octokit.rest.secretScanning.updateAlert({ diff --git a/docs/securityAdvisories/createFork.md b/docs/securityAdvisories/createFork.md new file mode 100644 index 000000000..109c4a214 --- /dev/null +++ b/docs/securityAdvisories/createFork.md @@ -0,0 +1,52 @@ +--- +name: Create a temporary private fork +example: octokit.rest.securityAdvisories.createFork({ owner, repo, ghsa_id }) +route: POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks +scope: securityAdvisories +type: API method +--- + +# Create a temporary private fork + +Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. + +**Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + +```js +octokit.rest.securityAdvisories.createFork({ + owner, + repo, + ghsa_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. + +
ghsa_idyes + +The GHSA (GitHub Security Advisory) identifier of the advisory. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork). diff --git a/docs/securityAdvisories/createPrivateVulnerabilityReport.md b/docs/securityAdvisories/createPrivateVulnerabilityReport.md index 9aff65f25..b089bd1fd 100644 --- a/docs/securityAdvisories/createPrivateVulnerabilityReport.md +++ b/docs/securityAdvisories/createPrivateVulnerabilityReport.md @@ -102,6 +102,11 @@ The severity of the advisory. You must choose between setting this field or `cvs The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + +start_private_forkno + +Whether to create a temporary private fork of the repository to collaborate on a fix. + diff --git a/docs/securityAdvisories/createRepositoryAdvisory.md b/docs/securityAdvisories/createRepositoryAdvisory.md index ce03f9a2b..006791992 100644 --- a/docs/securityAdvisories/createRepositoryAdvisory.md +++ b/docs/securityAdvisories/createRepositoryAdvisory.md @@ -9,9 +9,10 @@ type: API method # Create a repository security advisory Creates a new repository security advisory. -You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. -In order to create a draft repository security advisory, you must be a security manager or administrator of that repository. +In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + +OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. ```js octokit.rest.securityAdvisories.createRepositoryAdvisory({ @@ -127,6 +128,11 @@ The severity of the advisory. You must choose between setting this field or `cvs The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + +start_private_forkno + +Whether to create a temporary private fork of the repository to collaborate on a fix. + diff --git a/docs/securityAdvisories/createRepositoryAdvisoryCveRequest.md b/docs/securityAdvisories/createRepositoryAdvisoryCveRequest.md index c6de652f4..0c0ea2ec0 100644 --- a/docs/securityAdvisories/createRepositoryAdvisoryCveRequest.md +++ b/docs/securityAdvisories/createRepositoryAdvisoryCveRequest.md @@ -12,9 +12,9 @@ If you want a CVE identification number for the security vulnerability in your p You may request a CVE for public repositories, but cannot do so for private repositories. -You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. +In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. -In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. +OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. ```js octokit.rest.securityAdvisories.createRepositoryAdvisoryCveRequest({ diff --git a/docs/securityAdvisories/getRepositoryAdvisory.md b/docs/securityAdvisories/getRepositoryAdvisory.md index b977fae08..09e50ce4a 100644 --- a/docs/securityAdvisories/getRepositoryAdvisory.md +++ b/docs/securityAdvisories/getRepositoryAdvisory.md @@ -9,13 +9,14 @@ type: API method # Get a repository security advisory Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. -You can access any published security advisory on a public repository. -You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission -in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to. -You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a +Anyone can access any published security advisory on a public repository. + +The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on the security advisory. +OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. + ```js octokit.rest.securityAdvisories.getRepositoryAdvisory({ owner, diff --git a/docs/securityAdvisories/listGlobalAdvisories.md b/docs/securityAdvisories/listGlobalAdvisories.md index 7b2f71f79..2e39f5af7 100644 --- a/docs/securityAdvisories/listGlobalAdvisories.md +++ b/docs/securityAdvisories/listGlobalAdvisories.md @@ -95,12 +95,12 @@ For more information on the syntax of the date range, see "[Understanding the se beforeno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." afterno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." directionno @@ -110,7 +110,7 @@ The direction to sort the results by. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." sortno diff --git a/docs/securityAdvisories/listOrgRepositoryAdvisories.md b/docs/securityAdvisories/listOrgRepositoryAdvisories.md index 6f6093eed..c1e4d58e0 100644 --- a/docs/securityAdvisories/listOrgRepositoryAdvisories.md +++ b/docs/securityAdvisories/listOrgRepositoryAdvisories.md @@ -10,7 +10,9 @@ type: API method Lists repository security advisories for an organization. -To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. +The authenticated user must be an owner or security manager for the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. ```js octokit.rest.securityAdvisories.listOrgRepositoryAdvisories({ @@ -46,17 +48,17 @@ The property to sort the results by. beforeno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." afterno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -The number of advisories to return per page. +The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." stateno diff --git a/docs/securityAdvisories/listRepositoryAdvisories.md b/docs/securityAdvisories/listRepositoryAdvisories.md index 3ebdcd6ba..7c8d41541 100644 --- a/docs/securityAdvisories/listRepositoryAdvisories.md +++ b/docs/securityAdvisories/listRepositoryAdvisories.md @@ -9,10 +9,10 @@ type: API method # List repository security advisories Lists security advisories in a repository. -You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission -in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to. -You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory. +The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + +OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. ```js octokit.rest.securityAdvisories.listRepositoryAdvisories({ @@ -54,17 +54,17 @@ The property to sort the results by. beforeno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." afterno -A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." per_pageno -Number of advisories to return per page. +The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." stateno diff --git a/docs/securityAdvisories/updateRepositoryAdvisory.md b/docs/securityAdvisories/updateRepositoryAdvisory.md index 01dfe4049..438b3dcbf 100644 --- a/docs/securityAdvisories/updateRepositoryAdvisory.md +++ b/docs/securityAdvisories/updateRepositoryAdvisory.md @@ -9,11 +9,12 @@ type: API method # Update a repository security advisory Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. -You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. -In order to update any security advisory, you must be a security manager or administrator of that repository, +In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, or a collaborator on the repository security advisory. +OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + ```js octokit.rest.securityAdvisories.updateRepositoryAdvisory({ owner, diff --git a/docs/teams/addOrUpdateProjectPermissionsInOrg.md b/docs/teams/addOrUpdateProjectPermissionsInOrg.md index 3ae5db05e..83927b6c0 100644 --- a/docs/teams/addOrUpdateProjectPermissionsInOrg.md +++ b/docs/teams/addOrUpdateProjectPermissionsInOrg.md @@ -48,7 +48,7 @@ The unique identifier of the project. permissionno -The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." +The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." diff --git a/docs/teams/addOrUpdateRepoPermissionsInOrg.md b/docs/teams/addOrUpdateRepoPermissionsInOrg.md index 2ce5a8cb8..054e00785 100644 --- a/docs/teams/addOrUpdateRepoPermissionsInOrg.md +++ b/docs/teams/addOrUpdateRepoPermissionsInOrg.md @@ -8,7 +8,7 @@ type: API method # Add or update team repository permissions -To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." +To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. diff --git a/docs/teams/checkPermissionsForRepoInOrg.md b/docs/teams/checkPermissionsForRepoInOrg.md index 274426cba..088bffad2 100644 --- a/docs/teams/checkPermissionsForRepoInOrg.md +++ b/docs/teams/checkPermissionsForRepoInOrg.md @@ -14,6 +14,8 @@ You can also get information about the specified repository, including what perm If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. +If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. + **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. ```js diff --git a/docs/teams/createDiscussionCommentInOrg.md b/docs/teams/createDiscussionCommentInOrg.md index a610bdc5c..62bc79c3e 100644 --- a/docs/teams/createDiscussionCommentInOrg.md +++ b/docs/teams/createDiscussionCommentInOrg.md @@ -8,12 +8,14 @@ type: API method # Create a discussion comment -Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Creates a new comment on a team discussion. -This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. +OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + ```js octokit.rest.teams.createDiscussionCommentInOrg({ org, diff --git a/docs/teams/createDiscussionInOrg.md b/docs/teams/createDiscussionInOrg.md index 0fe384891..69479ccfe 100644 --- a/docs/teams/createDiscussionInOrg.md +++ b/docs/teams/createDiscussionInOrg.md @@ -8,12 +8,14 @@ type: API method # Create a discussion -Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Creates a new discussion post on a team's page. -This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. +OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + ```js octokit.rest.teams.createDiscussionInOrg({ org, diff --git a/docs/teams/deleteDiscussionCommentInOrg.md b/docs/teams/deleteDiscussionCommentInOrg.md index fe4085a4d..4cfe6c61b 100644 --- a/docs/teams/deleteDiscussionCommentInOrg.md +++ b/docs/teams/deleteDiscussionCommentInOrg.md @@ -8,10 +8,12 @@ type: API method # Delete a discussion comment -Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Deletes a comment on a team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. +OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + ```js octokit.rest.teams.deleteDiscussionCommentInOrg({ org, diff --git a/docs/teams/deleteDiscussionInOrg.md b/docs/teams/deleteDiscussionInOrg.md index d433afed7..f87b7cc9b 100644 --- a/docs/teams/deleteDiscussionInOrg.md +++ b/docs/teams/deleteDiscussionInOrg.md @@ -8,10 +8,12 @@ type: API method # Delete a discussion -Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Delete a discussion from a team's page. **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. +OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + ```js octokit.rest.teams.deleteDiscussionInOrg({ org, diff --git a/docs/teams/getDiscussionCommentInOrg.md b/docs/teams/getDiscussionCommentInOrg.md index a8b75f1b0..f4a3919b3 100644 --- a/docs/teams/getDiscussionCommentInOrg.md +++ b/docs/teams/getDiscussionCommentInOrg.md @@ -8,10 +8,12 @@ type: API method # Get a discussion comment -Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Get a specific comment on a team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. +OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + ```js octokit.rest.teams.getDiscussionCommentInOrg({ org, diff --git a/docs/teams/getDiscussionInOrg.md b/docs/teams/getDiscussionInOrg.md index a9ff8f017..48be4dcc4 100644 --- a/docs/teams/getDiscussionInOrg.md +++ b/docs/teams/getDiscussionInOrg.md @@ -8,10 +8,12 @@ type: API method # Get a discussion -Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Get a specific discussion on a team's page. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. +OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + ```js octokit.rest.teams.getDiscussionInOrg({ org, diff --git a/docs/teams/list.md b/docs/teams/list.md index e97b4a41d..8d2eb52b7 100644 --- a/docs/teams/list.md +++ b/docs/teams/list.md @@ -34,12 +34,12 @@ The organization name. The name is not case sensitive. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/teams/listChildInOrg.md b/docs/teams/listChildInOrg.md index 729af6f1d..c4a4d1a38 100644 --- a/docs/teams/listChildInOrg.md +++ b/docs/teams/listChildInOrg.md @@ -42,12 +42,12 @@ The slug of the team name. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/teams/listDiscussionCommentsInOrg.md b/docs/teams/listDiscussionCommentsInOrg.md index d38c228b8..d9075eb4d 100644 --- a/docs/teams/listDiscussionCommentsInOrg.md +++ b/docs/teams/listDiscussionCommentsInOrg.md @@ -8,10 +8,12 @@ type: API method # List discussion comments -List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +List all comments on a team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. +OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + ```js octokit.rest.teams.listDiscussionCommentsInOrg({ org, @@ -53,12 +55,12 @@ The direction to sort the results by. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/teams/listDiscussionsInOrg.md b/docs/teams/listDiscussionsInOrg.md index 95b8df5d4..ff91c11a4 100644 --- a/docs/teams/listDiscussionsInOrg.md +++ b/docs/teams/listDiscussionsInOrg.md @@ -8,10 +8,12 @@ type: API method # List discussions -List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +List all discussions on a team's page. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. +OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + ```js octokit.rest.teams.listDiscussionsInOrg({ org, @@ -47,12 +49,12 @@ The direction to sort the results by. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pinnedno diff --git a/docs/teams/listForAuthenticatedUser.md b/docs/teams/listForAuthenticatedUser.md index c5229d6e3..7adf601db 100644 --- a/docs/teams/listForAuthenticatedUser.md +++ b/docs/teams/listForAuthenticatedUser.md @@ -8,7 +8,12 @@ type: API method # List teams for the authenticated user -List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. +List all of the teams across all of the organizations to which the authenticated +user belongs. + +OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + +When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. ```js octokit.rest.teams.listForAuthenticatedUser(); @@ -27,12 +32,12 @@ octokit.rest.teams.listForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/teams/listMembersInOrg.md b/docs/teams/listMembersInOrg.md index fd1519c91..8de65ffc9 100644 --- a/docs/teams/listMembersInOrg.md +++ b/docs/teams/listMembersInOrg.md @@ -47,12 +47,12 @@ Filters members returned by their role in the team. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/teams/listPendingInvitationsInOrg.md b/docs/teams/listPendingInvitationsInOrg.md index 20a4386d9..5d5bcb2f4 100644 --- a/docs/teams/listPendingInvitationsInOrg.md +++ b/docs/teams/listPendingInvitationsInOrg.md @@ -42,12 +42,12 @@ The slug of the team name. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/teams/listProjectsInOrg.md b/docs/teams/listProjectsInOrg.md index 3ca20368d..f2ed91963 100644 --- a/docs/teams/listProjectsInOrg.md +++ b/docs/teams/listProjectsInOrg.md @@ -42,12 +42,12 @@ The slug of the team name. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/teams/listReposInOrg.md b/docs/teams/listReposInOrg.md index 6c6c82afb..6b3487817 100644 --- a/docs/teams/listReposInOrg.md +++ b/docs/teams/listReposInOrg.md @@ -42,12 +42,12 @@ The slug of the team name. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/teams/updateDiscussionCommentInOrg.md b/docs/teams/updateDiscussionCommentInOrg.md index 928b5dbf9..e63478d3d 100644 --- a/docs/teams/updateDiscussionCommentInOrg.md +++ b/docs/teams/updateDiscussionCommentInOrg.md @@ -8,10 +8,12 @@ type: API method # Update a discussion comment -Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Edits the body text of a discussion comment. **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. +OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + ```js octokit.rest.teams.updateDiscussionCommentInOrg({ org, diff --git a/docs/teams/updateDiscussionInOrg.md b/docs/teams/updateDiscussionInOrg.md index 263ead104..e7b61b2cb 100644 --- a/docs/teams/updateDiscussionInOrg.md +++ b/docs/teams/updateDiscussionInOrg.md @@ -8,10 +8,12 @@ type: API method # Update a discussion -Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Edits the title and body text of a discussion post. Only the parameters you provide are updated. **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. +OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + ```js octokit.rest.teams.updateDiscussionInOrg({ org, diff --git a/docs/users/addEmailForAuthenticated.md b/docs/users/addEmailForAuthenticated.md index 75147ab3d..16de11296 100644 --- a/docs/users/addEmailForAuthenticated.md +++ b/docs/users/addEmailForAuthenticated.md @@ -10,7 +10,7 @@ type: API method **Deprecated:** This method has been renamed to users.addEmailForAuthenticatedUser -This endpoint is accessible with the `user` scope. +OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. ```js octokit.rest.users.addEmailForAuthenticated({ diff --git a/docs/users/addEmailForAuthenticatedUser.md b/docs/users/addEmailForAuthenticatedUser.md index d65d80d99..dc96a8ded 100644 --- a/docs/users/addEmailForAuthenticatedUser.md +++ b/docs/users/addEmailForAuthenticatedUser.md @@ -8,7 +8,7 @@ type: API method # Add an email address for the authenticated user -This endpoint is accessible with the `user` scope. +OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. ```js octokit.rest.users.addEmailForAuthenticatedUser({ diff --git a/docs/users/addSocialAccountForAuthenticatedUser.md b/docs/users/addSocialAccountForAuthenticatedUser.md index 5c3ef149e..880893095 100644 --- a/docs/users/addSocialAccountForAuthenticatedUser.md +++ b/docs/users/addSocialAccountForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # Add social accounts for the authenticated user -Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. +Add one or more social accounts to the authenticated user's profile. + +OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. ```js octokit.rest.users.addSocialAccountForAuthenticatedUser({ diff --git a/docs/users/createGpgKeyForAuthenticated.md b/docs/users/createGpgKeyForAuthenticated.md index 26bb1009b..5a1a8fdc1 100644 --- a/docs/users/createGpgKeyForAuthenticated.md +++ b/docs/users/createGpgKeyForAuthenticated.md @@ -10,7 +10,9 @@ type: API method **Deprecated:** This method has been renamed to users.createGpgKeyForAuthenticatedUser -Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Adds a GPG key to the authenticated user's GitHub account. + +OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. ```js octokit.rest.users.createGpgKeyForAuthenticated({ diff --git a/docs/users/createGpgKeyForAuthenticatedUser.md b/docs/users/createGpgKeyForAuthenticatedUser.md index c03cfc303..0363f247f 100644 --- a/docs/users/createGpgKeyForAuthenticatedUser.md +++ b/docs/users/createGpgKeyForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # Create a GPG key for the authenticated user -Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Adds a GPG key to the authenticated user's GitHub account. + +OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. ```js octokit.rest.users.createGpgKeyForAuthenticatedUser({ diff --git a/docs/users/createPublicSshKeyForAuthenticated.md b/docs/users/createPublicSshKeyForAuthenticated.md index 83de8c446..1ae54e1b9 100644 --- a/docs/users/createPublicSshKeyForAuthenticated.md +++ b/docs/users/createPublicSshKeyForAuthenticated.md @@ -10,7 +10,9 @@ type: API method **Deprecated:** This method has been renamed to users.createPublicSshKeyForAuthenticatedUser -Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Adds a public SSH key to the authenticated user's GitHub account. + +OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. ```js octokit.rest.users.createPublicSshKeyForAuthenticated({ diff --git a/docs/users/createPublicSshKeyForAuthenticatedUser.md b/docs/users/createPublicSshKeyForAuthenticatedUser.md index 839575da1..df4582810 100644 --- a/docs/users/createPublicSshKeyForAuthenticatedUser.md +++ b/docs/users/createPublicSshKeyForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # Create a public SSH key for the authenticated user -Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Adds a public SSH key to the authenticated user's GitHub account. + +OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. ```js octokit.rest.users.createPublicSshKeyForAuthenticatedUser({ diff --git a/docs/users/createSshSigningKeyForAuthenticatedUser.md b/docs/users/createSshSigningKeyForAuthenticatedUser.md index 0d43956a1..bb30e7637 100644 --- a/docs/users/createSshSigningKeyForAuthenticatedUser.md +++ b/docs/users/createSshSigningKeyForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # Create a SSH signing key for the authenticated user -Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." +Creates an SSH signing key for the authenticated user's GitHub account. + +OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. ```js octokit.rest.users.createSshSigningKeyForAuthenticatedUser({ diff --git a/docs/users/deleteEmailForAuthenticated.md b/docs/users/deleteEmailForAuthenticated.md index 5db873b93..77ebab7b8 100644 --- a/docs/users/deleteEmailForAuthenticated.md +++ b/docs/users/deleteEmailForAuthenticated.md @@ -10,7 +10,7 @@ type: API method **Deprecated:** This method has been renamed to users.deleteEmailForAuthenticatedUser -This endpoint is accessible with the `user` scope. +OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. ```js octokit.rest.users.deleteEmailForAuthenticated({ diff --git a/docs/users/deleteEmailForAuthenticatedUser.md b/docs/users/deleteEmailForAuthenticatedUser.md index 54b5915b9..27cfcbab6 100644 --- a/docs/users/deleteEmailForAuthenticatedUser.md +++ b/docs/users/deleteEmailForAuthenticatedUser.md @@ -8,7 +8,7 @@ type: API method # Delete an email address for the authenticated user -This endpoint is accessible with the `user` scope. +OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. ```js octokit.rest.users.deleteEmailForAuthenticatedUser({ diff --git a/docs/users/deleteGpgKeyForAuthenticated.md b/docs/users/deleteGpgKeyForAuthenticated.md index 988fbc10b..193ac13cd 100644 --- a/docs/users/deleteGpgKeyForAuthenticated.md +++ b/docs/users/deleteGpgKeyForAuthenticated.md @@ -10,7 +10,9 @@ type: API method **Deprecated:** This method has been renamed to users.deleteGpgKeyForAuthenticatedUser -Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Removes a GPG key from the authenticated user's GitHub account. + +OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. ```js octokit.rest.users.deleteGpgKeyForAuthenticated({ diff --git a/docs/users/deleteGpgKeyForAuthenticatedUser.md b/docs/users/deleteGpgKeyForAuthenticatedUser.md index c4d9bf129..13c30cb8d 100644 --- a/docs/users/deleteGpgKeyForAuthenticatedUser.md +++ b/docs/users/deleteGpgKeyForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # Delete a GPG key for the authenticated user -Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Removes a GPG key from the authenticated user's GitHub account. + +OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. ```js octokit.rest.users.deleteGpgKeyForAuthenticatedUser({ diff --git a/docs/users/deletePublicSshKeyForAuthenticated.md b/docs/users/deletePublicSshKeyForAuthenticated.md index a53f9f9ee..e43c78118 100644 --- a/docs/users/deletePublicSshKeyForAuthenticated.md +++ b/docs/users/deletePublicSshKeyForAuthenticated.md @@ -10,7 +10,9 @@ type: API method **Deprecated:** This method has been renamed to users.deletePublicSshKeyForAuthenticatedUser -Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Removes a public SSH key from the authenticated user's GitHub account. + +OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. ```js octokit.rest.users.deletePublicSshKeyForAuthenticated({ diff --git a/docs/users/deletePublicSshKeyForAuthenticatedUser.md b/docs/users/deletePublicSshKeyForAuthenticatedUser.md index 9db435266..00f49d7c0 100644 --- a/docs/users/deletePublicSshKeyForAuthenticatedUser.md +++ b/docs/users/deletePublicSshKeyForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # Delete a public SSH key for the authenticated user -Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Removes a public SSH key from the authenticated user's GitHub account. + +OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. ```js octokit.rest.users.deletePublicSshKeyForAuthenticatedUser({ diff --git a/docs/users/deleteSocialAccountForAuthenticatedUser.md b/docs/users/deleteSocialAccountForAuthenticatedUser.md index 04b052c62..9f89fdd15 100644 --- a/docs/users/deleteSocialAccountForAuthenticatedUser.md +++ b/docs/users/deleteSocialAccountForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # Delete social accounts for the authenticated user -Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope. +Deletes one or more social accounts from the authenticated user's profile. + +OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. ```js octokit.rest.users.deleteSocialAccountForAuthenticatedUser({ diff --git a/docs/users/deleteSshSigningKeyForAuthenticatedUser.md b/docs/users/deleteSshSigningKeyForAuthenticatedUser.md index ae529a215..0165925b1 100644 --- a/docs/users/deleteSshSigningKeyForAuthenticatedUser.md +++ b/docs/users/deleteSshSigningKeyForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # Delete an SSH signing key for the authenticated user -Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." +Deletes an SSH signing key from the authenticated user's GitHub account. + +OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. ```js octokit.rest.users.deleteSshSigningKeyForAuthenticatedUser({ diff --git a/docs/users/follow.md b/docs/users/follow.md index 01e9e4812..e5c72a1cb 100644 --- a/docs/users/follow.md +++ b/docs/users/follow.md @@ -8,9 +8,9 @@ type: API method # Follow a user -Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." +Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." -Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. +OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. ```js octokit.rest.users.follow({ diff --git a/docs/users/getAuthenticated.md b/docs/users/getAuthenticated.md index 98f720b99..ba109b660 100644 --- a/docs/users/getAuthenticated.md +++ b/docs/users/getAuthenticated.md @@ -8,9 +8,7 @@ type: API method # Get the authenticated user -If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. - -If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. +OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. ```js octokit.rest.users.getAuthenticated(); diff --git a/docs/users/getByUsername.md b/docs/users/getByUsername.md index c2e243702..f70ab57a8 100644 --- a/docs/users/getByUsername.md +++ b/docs/users/getByUsername.md @@ -10,9 +10,7 @@ type: API method Provides publicly available information about someone with a GitHub account. -GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" - -The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). +The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". diff --git a/docs/users/getContextForUser.md b/docs/users/getContextForUser.md index 1856860ff..e79832c5d 100644 --- a/docs/users/getContextForUser.md +++ b/docs/users/getContextForUser.md @@ -8,7 +8,7 @@ type: API method # Get contextual information for a user -Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. +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: @@ -17,6 +17,8 @@ The `subject_type` and `subject_id` parameters provide context for the person's https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 ``` +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + ```js octokit.rest.users.getContextForUser({ username, diff --git a/docs/users/getGpgKeyForAuthenticated.md b/docs/users/getGpgKeyForAuthenticated.md index 2b1de7114..9ee2770ee 100644 --- a/docs/users/getGpgKeyForAuthenticated.md +++ b/docs/users/getGpgKeyForAuthenticated.md @@ -10,7 +10,9 @@ type: API method **Deprecated:** This method has been renamed to users.getGpgKeyForAuthenticatedUser -View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +View extended details for a single GPG key. + +OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. ```js octokit.rest.users.getGpgKeyForAuthenticated({ diff --git a/docs/users/getGpgKeyForAuthenticatedUser.md b/docs/users/getGpgKeyForAuthenticatedUser.md index 4ace4a5ec..934e391b4 100644 --- a/docs/users/getGpgKeyForAuthenticatedUser.md +++ b/docs/users/getGpgKeyForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # Get a GPG key for the authenticated user -View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +View extended details for a single GPG key. + +OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. ```js octokit.rest.users.getGpgKeyForAuthenticatedUser({ diff --git a/docs/users/getPublicSshKeyForAuthenticated.md b/docs/users/getPublicSshKeyForAuthenticated.md index 3ac11a39a..aedf464b1 100644 --- a/docs/users/getPublicSshKeyForAuthenticated.md +++ b/docs/users/getPublicSshKeyForAuthenticated.md @@ -10,7 +10,9 @@ type: API method **Deprecated:** This method has been renamed to users.getPublicSshKeyForAuthenticatedUser -View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +View extended details for a single public SSH key. + +OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. ```js octokit.rest.users.getPublicSshKeyForAuthenticated({ diff --git a/docs/users/getPublicSshKeyForAuthenticatedUser.md b/docs/users/getPublicSshKeyForAuthenticatedUser.md index 09eaec814..3918f97ea 100644 --- a/docs/users/getPublicSshKeyForAuthenticatedUser.md +++ b/docs/users/getPublicSshKeyForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # Get a public SSH key for the authenticated user -View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +View extended details for a single public SSH key. + +OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. ```js octokit.rest.users.getPublicSshKeyForAuthenticatedUser({ diff --git a/docs/users/getSshSigningKeyForAuthenticatedUser.md b/docs/users/getSshSigningKeyForAuthenticatedUser.md index 4f22e0b59..3be9afd41 100644 --- a/docs/users/getSshSigningKeyForAuthenticatedUser.md +++ b/docs/users/getSshSigningKeyForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # Get an SSH signing key for the authenticated user -Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." +Gets extended details for an SSH signing key. + +OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. ```js octokit.rest.users.getSshSigningKeyForAuthenticatedUser({ diff --git a/docs/users/list.md b/docs/users/list.md index c2f99753a..c40173f17 100644 --- a/docs/users/list.md +++ b/docs/users/list.md @@ -34,7 +34,7 @@ A user ID. Only return users with an ID greater than this ID. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listBlockedByAuthenticated.md b/docs/users/listBlockedByAuthenticated.md index 0f4aeff33..cb481ea66 100644 --- a/docs/users/listBlockedByAuthenticated.md +++ b/docs/users/listBlockedByAuthenticated.md @@ -29,12 +29,12 @@ octokit.rest.users.listBlockedByAuthenticated(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listBlockedByAuthenticatedUser.md b/docs/users/listBlockedByAuthenticatedUser.md index 7fd700ff0..16d8a85ac 100644 --- a/docs/users/listBlockedByAuthenticatedUser.md +++ b/docs/users/listBlockedByAuthenticatedUser.md @@ -27,12 +27,12 @@ octokit.rest.users.listBlockedByAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listEmailsForAuthenticated.md b/docs/users/listEmailsForAuthenticated.md index 14668542a..ac3f6732f 100644 --- a/docs/users/listEmailsForAuthenticated.md +++ b/docs/users/listEmailsForAuthenticated.md @@ -10,7 +10,10 @@ type: API method **Deprecated:** This method has been renamed to users.listEmailsForAuthenticatedUser -Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. +Lists all of your email addresses, and specifies which one is visible +to the public. + +OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. ```js octokit.rest.users.listEmailsForAuthenticated(); @@ -29,12 +32,12 @@ octokit.rest.users.listEmailsForAuthenticated(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listEmailsForAuthenticatedUser.md b/docs/users/listEmailsForAuthenticatedUser.md index 242954687..3ff87561b 100644 --- a/docs/users/listEmailsForAuthenticatedUser.md +++ b/docs/users/listEmailsForAuthenticatedUser.md @@ -8,7 +8,10 @@ type: API method # List email addresses for the authenticated user -Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. +Lists all of your email addresses, and specifies which one is visible +to the public. + +OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. ```js octokit.rest.users.listEmailsForAuthenticatedUser(); @@ -27,12 +30,12 @@ octokit.rest.users.listEmailsForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listFollowedByAuthenticated.md b/docs/users/listFollowedByAuthenticated.md index 3d7286ec8..190bdfe57 100644 --- a/docs/users/listFollowedByAuthenticated.md +++ b/docs/users/listFollowedByAuthenticated.md @@ -29,12 +29,12 @@ octokit.rest.users.listFollowedByAuthenticated(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listFollowedByAuthenticatedUser.md b/docs/users/listFollowedByAuthenticatedUser.md index 564633e5b..769044937 100644 --- a/docs/users/listFollowedByAuthenticatedUser.md +++ b/docs/users/listFollowedByAuthenticatedUser.md @@ -27,12 +27,12 @@ octokit.rest.users.listFollowedByAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listFollowersForAuthenticatedUser.md b/docs/users/listFollowersForAuthenticatedUser.md index 2c8f4c6e0..204dd09f9 100644 --- a/docs/users/listFollowersForAuthenticatedUser.md +++ b/docs/users/listFollowersForAuthenticatedUser.md @@ -27,12 +27,12 @@ octokit.rest.users.listFollowersForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listFollowersForUser.md b/docs/users/listFollowersForUser.md index 43eb28a4e..deed8f879 100644 --- a/docs/users/listFollowersForUser.md +++ b/docs/users/listFollowersForUser.md @@ -34,12 +34,12 @@ The handle for the GitHub user account. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listFollowingForUser.md b/docs/users/listFollowingForUser.md index a4a7bb2d7..3cb010dad 100644 --- a/docs/users/listFollowingForUser.md +++ b/docs/users/listFollowingForUser.md @@ -34,12 +34,12 @@ The handle for the GitHub user account. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listGpgKeysForAuthenticated.md b/docs/users/listGpgKeysForAuthenticated.md index e3132b8dd..24cf3cbd5 100644 --- a/docs/users/listGpgKeysForAuthenticated.md +++ b/docs/users/listGpgKeysForAuthenticated.md @@ -10,7 +10,9 @@ type: API method **Deprecated:** This method has been renamed to users.listGpgKeysForAuthenticatedUser -Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Lists the current user's GPG keys. + +OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. ```js octokit.rest.users.listGpgKeysForAuthenticated(); @@ -29,12 +31,12 @@ octokit.rest.users.listGpgKeysForAuthenticated(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listGpgKeysForAuthenticatedUser.md b/docs/users/listGpgKeysForAuthenticatedUser.md index f12eba644..b67a27d18 100644 --- a/docs/users/listGpgKeysForAuthenticatedUser.md +++ b/docs/users/listGpgKeysForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # List GPG keys for the authenticated user -Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Lists the current user's GPG keys. + +OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. ```js octokit.rest.users.listGpgKeysForAuthenticatedUser(); @@ -27,12 +29,12 @@ octokit.rest.users.listGpgKeysForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listGpgKeysForUser.md b/docs/users/listGpgKeysForUser.md index 2cc8c56b6..de2cd5780 100644 --- a/docs/users/listGpgKeysForUser.md +++ b/docs/users/listGpgKeysForUser.md @@ -34,12 +34,12 @@ The handle for the GitHub user account. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listPublicEmailsForAuthenticated.md b/docs/users/listPublicEmailsForAuthenticated.md index fdcdd2a95..844ba4a77 100644 --- a/docs/users/listPublicEmailsForAuthenticated.md +++ b/docs/users/listPublicEmailsForAuthenticated.md @@ -10,7 +10,11 @@ type: API method **Deprecated:** This method has been renamed to users.listPublicEmailsForAuthenticatedUser -Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. +Lists your publicly visible email address, which you can set with the +[Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) +endpoint. + +OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. ```js octokit.rest.users.listPublicEmailsForAuthenticated(); @@ -29,12 +33,12 @@ octokit.rest.users.listPublicEmailsForAuthenticated(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listPublicEmailsForAuthenticatedUser.md b/docs/users/listPublicEmailsForAuthenticatedUser.md index d259d9069..8359fe008 100644 --- a/docs/users/listPublicEmailsForAuthenticatedUser.md +++ b/docs/users/listPublicEmailsForAuthenticatedUser.md @@ -8,7 +8,11 @@ type: API method # List public email addresses for the authenticated user -Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. +Lists your publicly visible email address, which you can set with the +[Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) +endpoint. + +OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. ```js octokit.rest.users.listPublicEmailsForAuthenticatedUser(); @@ -27,12 +31,12 @@ octokit.rest.users.listPublicEmailsForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listPublicKeysForUser.md b/docs/users/listPublicKeysForUser.md index 3a5b57b91..15f8a53b1 100644 --- a/docs/users/listPublicKeysForUser.md +++ b/docs/users/listPublicKeysForUser.md @@ -34,12 +34,12 @@ The handle for the GitHub user account. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listPublicSshKeysForAuthenticated.md b/docs/users/listPublicSshKeysForAuthenticated.md index 404247ce6..9fb63d872 100644 --- a/docs/users/listPublicSshKeysForAuthenticated.md +++ b/docs/users/listPublicSshKeysForAuthenticated.md @@ -10,7 +10,9 @@ type: API method **Deprecated:** This method has been renamed to users.listPublicSshKeysForAuthenticatedUser -Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Lists the public SSH keys for the authenticated user's GitHub account. + +OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. ```js octokit.rest.users.listPublicSshKeysForAuthenticated(); @@ -29,12 +31,12 @@ octokit.rest.users.listPublicSshKeysForAuthenticated(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listPublicSshKeysForAuthenticatedUser.md b/docs/users/listPublicSshKeysForAuthenticatedUser.md index 09eb93a3b..70bac6b48 100644 --- a/docs/users/listPublicSshKeysForAuthenticatedUser.md +++ b/docs/users/listPublicSshKeysForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # List public SSH keys for the authenticated user -Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). +Lists the public SSH keys for the authenticated user's GitHub account. + +OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. ```js octokit.rest.users.listPublicSshKeysForAuthenticatedUser(); @@ -27,12 +29,12 @@ octokit.rest.users.listPublicSshKeysForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listSocialAccountsForAuthenticatedUser.md b/docs/users/listSocialAccountsForAuthenticatedUser.md index cf977424c..e4bce2830 100644 --- a/docs/users/listSocialAccountsForAuthenticatedUser.md +++ b/docs/users/listSocialAccountsForAuthenticatedUser.md @@ -27,12 +27,12 @@ octokit.rest.users.listSocialAccountsForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listSocialAccountsForUser.md b/docs/users/listSocialAccountsForUser.md index fcd9d373f..dfef4fa80 100644 --- a/docs/users/listSocialAccountsForUser.md +++ b/docs/users/listSocialAccountsForUser.md @@ -34,12 +34,12 @@ The handle for the GitHub user account. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listSshSigningKeysForAuthenticatedUser.md b/docs/users/listSshSigningKeysForAuthenticatedUser.md index 407f0e3b0..086115189 100644 --- a/docs/users/listSshSigningKeysForAuthenticatedUser.md +++ b/docs/users/listSshSigningKeysForAuthenticatedUser.md @@ -8,7 +8,9 @@ type: API method # List SSH signing keys for the authenticated user -Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." +Lists the SSH signing keys for the authenticated user's GitHub account. + +OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. ```js octokit.rest.users.listSshSigningKeysForAuthenticatedUser(); @@ -27,12 +29,12 @@ octokit.rest.users.listSshSigningKeysForAuthenticatedUser(); per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/listSshSigningKeysForUser.md b/docs/users/listSshSigningKeysForUser.md index 56eefb9ad..95d07fcd8 100644 --- a/docs/users/listSshSigningKeysForUser.md +++ b/docs/users/listSshSigningKeysForUser.md @@ -34,12 +34,12 @@ The handle for the GitHub user account. per_pageno -The number of results per page (max 100). +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." pageno -Page number of the results to fetch. +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." diff --git a/docs/users/unfollow.md b/docs/users/unfollow.md index 4bc467a66..074241141 100644 --- a/docs/users/unfollow.md +++ b/docs/users/unfollow.md @@ -8,7 +8,7 @@ type: API method # Unfollow a user -Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. +OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. ```js octokit.rest.users.unfollow({ diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index fb32f2b23..cfc234a6d 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -8,7 +8,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Add custom labels to a self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization", "previews": [], "headers": [], @@ -81,7 +81,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Adds custom labels to a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], @@ -167,7 +167,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret", "previews": [], "headers": [], @@ -235,7 +235,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable", "previews": [], "headers": [], @@ -299,7 +299,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see [\"Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see [\"Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request", "previews": [], "headers": [], @@ -364,7 +364,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run", "previews": [], "headers": [], @@ -428,7 +428,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#create-an-environment-variable", "previews": [], "headers": [], @@ -448,7 +448,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -504,7 +504,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret", "previews": [], "headers": [], @@ -524,7 +524,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -705,7 +705,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret", "previews": [], "headers": [], @@ -799,7 +799,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#create-an-organization-variable", "previews": [], "headers": [], @@ -888,7 +888,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token: \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization", "previews": [], "headers": [], @@ -929,7 +929,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository", "previews": [], "headers": [], @@ -983,7 +983,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization", "previews": [], "headers": [], @@ -1024,7 +1024,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository", "previews": [], "headers": [], @@ -1078,7 +1078,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#create-a-repository-variable", "previews": [], "headers": [], @@ -1154,7 +1154,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", + "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event", "previews": [], "headers": [], @@ -1250,7 +1250,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a GitHub Actions cache for a repository, using a cache ID.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\n\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Deletes a GitHub Actions cache for a repository, using a cache ID.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id", "previews": [], "headers": [], @@ -1307,7 +1307,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\n\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key", "previews": [], "headers": [], @@ -1387,7 +1387,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/artifacts#delete-an-artifact", "previews": [], "headers": [], @@ -1444,7 +1444,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a secret in an environment using the secret name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Deletes a secret in an environment using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#delete-an-environment-secret", "previews": [], "headers": [], @@ -1464,7 +1464,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -1503,7 +1503,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes an environment variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#delete-an-environment-variable", "previews": [], "headers": [], @@ -1536,7 +1536,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -1560,7 +1560,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a secret in an organization using the secret name.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#delete-an-organization-secret", "previews": [], "headers": [], @@ -1604,7 +1604,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes an organization variable using the variable name.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#delete-an-organization-variable", "previews": [], "headers": [], @@ -1648,7 +1648,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a secret in a repository using the secret name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Deletes a secret in a repository using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#delete-a-repository-secret", "previews": [], "headers": [], @@ -1705,7 +1705,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes a repository variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#delete-a-repository-variable", "previews": [], "headers": [], @@ -1762,7 +1762,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization", "previews": [], "headers": [], @@ -1806,7 +1806,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository", "previews": [], "headers": [], @@ -1863,7 +1863,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is\nprivate you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use\nthis endpoint.", + "description": "Deletes a specific workflow run.\n\nAnyone with write access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run", "previews": [], "headers": [], @@ -1920,7 +1920,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Deletes all logs for a workflow run.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs", "previews": [], "headers": [], @@ -1981,7 +1981,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization", "previews": [], "headers": [], @@ -2025,7 +2025,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflows#disable-a-workflow", "previews": [], "headers": [], @@ -2082,7 +2082,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/artifacts#download-an-artifact", "previews": [], "headers": [], @@ -2155,7 +2155,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can\nuse this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must\nhave the `actions:read` permission to use this endpoint.", + "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run", "previews": [], "headers": [], @@ -2212,7 +2212,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs", "previews": [], "headers": [], @@ -2282,7 +2282,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use\nthis endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have\nthe `actions:read` permission to use this endpoint.", + "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs", "previews": [], "headers": [], @@ -2339,7 +2339,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization", "previews": [], "headers": [], @@ -2383,7 +2383,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflows#enable-a-workflow", "previews": [], "headers": [], @@ -2440,7 +2440,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run", "previews": [], "headers": [], @@ -2504,7 +2504,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization", "previews": [], "headers": [], @@ -2603,7 +2603,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the repository.\n\nOAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository", "previews": [], "headers": [], @@ -2715,7 +2715,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the GitHub Actions caches for a repository.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Lists the GitHub Actions caches for a repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository", "previews": [], "headers": [], @@ -2748,7 +2748,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -2761,7 +2761,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -2847,7 +2847,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository", "previews": [], "headers": [], @@ -2901,7 +2901,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\nYou must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.", + "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization", "previews": [], "headers": [], @@ -2921,7 +2921,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -2934,7 +2934,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -2968,7 +2968,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\nYou must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.", + "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization", "previews": [], "headers": [], @@ -3009,7 +3009,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "description": "Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization", "previews": [], "headers": [], @@ -3050,7 +3050,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "description": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository", "previews": [], "headers": [], @@ -3104,7 +3104,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a specific artifact for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/artifacts#get-an-artifact", "previews": [], "headers": [], @@ -3171,7 +3171,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#get-an-environment-public-key", "previews": [], "headers": [], @@ -3191,7 +3191,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -3225,7 +3225,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a single environment secret without revealing its encrypted value.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Gets a single environment secret without revealing its encrypted value.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#get-an-environment-secret", "previews": [], "headers": [], @@ -3245,7 +3245,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -3292,7 +3292,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in an environment.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#get-an-environment-variable", "previews": [], "headers": [], @@ -3312,7 +3312,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -3359,7 +3359,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization", "previews": [], "headers": [], @@ -3400,7 +3400,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository", "previews": [], "headers": [], @@ -3454,7 +3454,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization", "previews": [], "headers": [], @@ -3495,7 +3495,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository", "previews": [], "headers": [], @@ -3549,7 +3549,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a specific job in a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run", "previews": [], "headers": [], @@ -3616,7 +3616,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#get-an-organization-public-key", "previews": [], "headers": [], @@ -3657,7 +3657,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a single organization secret without revealing its encrypted value.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#get-an-organization-secret", "previews": [], "headers": [], @@ -3711,7 +3711,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific variable in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#get-an-organization-variable", "previews": [], "headers": [], @@ -3765,7 +3765,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run", "previews": [], "headers": [], @@ -3832,7 +3832,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository", "previews": [], "headers": [], @@ -3894,7 +3894,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#get-a-repository-public-key", "previews": [], "headers": [], @@ -3948,7 +3948,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a single repository secret without revealing its encrypted value.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Gets a single repository secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#get-a-repository-secret", "previews": [], "headers": [], @@ -4015,7 +4015,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in a repository.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#get-a-repository-variable", "previews": [], "headers": [], @@ -4082,7 +4082,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Anyone 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.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run", "previews": [], "headers": [], @@ -4149,7 +4149,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization", "previews": [], "headers": [], @@ -4203,7 +4203,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], @@ -4270,7 +4270,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow\nfile name. For example, you could use `main.yaml`.\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.", "documentationUrl": "https://docs.github.com/rest/actions/workflows#get-a-workflow", "previews": [], "headers": [], @@ -4337,7 +4337,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", + "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-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/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository", "previews": [], "headers": [], @@ -4387,7 +4387,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a specific workflow run.\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.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run", "previews": [], "headers": [], @@ -4467,7 +4467,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific workflow run attempt. Anyone with read access to the repository\ncan use this endpoint. If the repository is private you must use an access token\nwith the `repo` scope. GitHub Apps must have the `actions:read` permission to\nuse this endpoint.", + "description": "Gets a specific workflow run attempt.\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.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt", "previews": [], "headers": [], @@ -4560,7 +4560,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage", "previews": [], "headers": [], @@ -4627,7 +4627,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\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.", "documentationUrl": "https://docs.github.com/rest/actions/workflows#get-workflow-usage", "previews": [], "headers": [], @@ -4694,7 +4694,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Lists all artifacts for a repository.\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.", "documentationUrl": "https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository", "previews": [], "headers": [], @@ -4727,7 +4727,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -4740,7 +4740,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -4787,7 +4787,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#list-environment-secrets", "previews": [], "headers": [], @@ -4807,7 +4807,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -4820,7 +4820,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -4833,7 +4833,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -4867,7 +4867,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all environment variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#list-environment-variables", "previews": [], "headers": [], @@ -4887,7 +4887,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -4900,7 +4900,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30).", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -4913,7 +4913,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -4947,7 +4947,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).", + "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout 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.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run", "previews": [], "headers": [], @@ -5006,7 +5006,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5019,7 +5019,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5053,7 +5053,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).", + "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout 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.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt", "previews": [], "headers": [], @@ -5112,7 +5112,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5125,7 +5125,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5160,7 +5160,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization", "previews": [], "headers": [], @@ -5215,7 +5215,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], @@ -5283,7 +5283,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#list-organization-secrets", "previews": [], "headers": [], @@ -5303,7 +5303,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5316,7 +5316,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5350,7 +5350,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all organization variables.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/variables#list-organization-variables", "previews": [], "headers": [], @@ -5370,7 +5370,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30).", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5383,7 +5383,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5417,7 +5417,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets", "previews": [], "headers": [], @@ -5450,7 +5450,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5463,7 +5463,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5497,7 +5497,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all organization variables shared with a repository.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#list-repository-organization-variables", "previews": [], "headers": [], @@ -5530,7 +5530,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30).", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5543,7 +5543,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5577,7 +5577,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#list-repository-secrets", "previews": [], "headers": [], @@ -5610,7 +5610,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5623,7 +5623,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5657,7 +5657,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all repository variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#list-repository-variables", "previews": [], "headers": [], @@ -5690,7 +5690,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30).", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5703,7 +5703,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5737,7 +5737,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Lists the workflows in a repository.\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.", "documentationUrl": "https://docs.github.com/rest/actions/workflows#list-repository-workflows", "previews": [], "headers": [], @@ -5770,7 +5770,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5783,7 +5783,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5817,7 +5817,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization", "previews": [], "headers": [], @@ -5858,7 +5858,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository", "previews": [], "headers": [], @@ -5912,7 +5912,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret", "previews": [], "headers": [], @@ -5945,7 +5945,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5958,7 +5958,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -5992,7 +5992,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable", "previews": [], "headers": [], @@ -6025,7 +6025,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6038,7 +6038,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6077,7 +6077,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization", "previews": [], "headers": [], @@ -6097,7 +6097,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6110,7 +6110,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6144,7 +6144,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all self-hosted runners configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization", "previews": [], "headers": [], @@ -6177,7 +6177,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6190,7 +6190,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6224,7 +6224,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all self-hosted runners configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository", "previews": [], "headers": [], @@ -6270,7 +6270,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6283,7 +6283,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6317,7 +6317,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Lists artifacts for a workflow run.\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.", "documentationUrl": "https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts", "previews": [], "headers": [], @@ -6363,7 +6363,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6376,7 +6376,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6423,7 +6423,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](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.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow", "previews": [], "headers": [], @@ -6536,7 +6536,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6549,7 +6549,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6635,7 +6635,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/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "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.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository", "previews": [], "headers": [], @@ -6735,7 +6735,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6748,7 +6748,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -6834,7 +6834,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Re-run a job and its dependent jobs in a workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run", "previews": [], "headers": [], @@ -6911,7 +6911,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Re-runs your workflow run using its `id`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow", "previews": [], "headers": [], @@ -6987,7 +6987,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint.", + "description": "Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run", "previews": [], "headers": [], @@ -7063,7 +7063,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization", "previews": [], "headers": [], @@ -7118,7 +7118,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], @@ -7186,7 +7186,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization", "previews": [], "headers": [], @@ -7259,7 +7259,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], @@ -7345,7 +7345,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret", "previews": [], "headers": [], @@ -7413,7 +7413,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable", "previews": [], "headers": [], @@ -7477,7 +7477,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n**Note:** GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have read and write permission for **Deployments** to use this endpoint.", + "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n**Note:** GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run", "previews": [], "headers": [], @@ -7534,7 +7534,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nRequired reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.", + "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run", "previews": [], "headers": [], @@ -7640,7 +7640,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "description": "Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization", "previews": [], "headers": [], @@ -7710,7 +7710,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "description": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository", "previews": [], "headers": [], @@ -7793,7 +7793,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization", "previews": [], "headers": [], @@ -7866,7 +7866,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], @@ -7952,7 +7952,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization", "previews": [], "headers": [], @@ -8011,7 +8011,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository", "previews": [], "headers": [], @@ -8088,7 +8088,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization", "previews": [], "headers": [], @@ -8145,7 +8145,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the 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/permissions#set-github-actions-permissions-for-a-repository", "previews": [], "headers": [], @@ -8215,7 +8215,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret", "previews": [], "headers": [], @@ -8272,7 +8272,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this\nendpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable", "previews": [], "headers": [], @@ -8336,7 +8336,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization", "previews": [], "headers": [], @@ -8380,7 +8380,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\".\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", + "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-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/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository", "previews": [], "headers": [], @@ -8413,7 +8413,7 @@ }, { "name": "access_level", - "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization.", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.", "in": "BODY", "type": "string", "required": true, @@ -8437,7 +8437,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#update-an-environment-variable", "previews": [], "headers": [], @@ -8470,7 +8470,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -8507,7 +8507,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "documentationUrl": "https://docs.github.com/rest/actions/variables#update-an-organization-variable", "previews": [], "headers": [], @@ -8590,7 +8590,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/variables#update-a-repository-variable", "previews": [], "headers": [], @@ -8806,7 +8806,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](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "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.", "documentationUrl": "https://docs.github.com/rest/activity/feeds#get-feeds", "previews": [], "headers": [], @@ -9009,7 +9009,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9022,7 +9022,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9115,7 +9115,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9128,7 +9128,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 50).", + "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9207,7 +9207,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9220,7 +9220,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9261,7 +9261,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9274,7 +9274,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9344,7 +9344,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9357,7 +9357,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9415,7 +9415,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9428,7 +9428,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9482,7 +9482,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9495,7 +9495,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9529,7 +9529,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", "documentationUrl": "https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user", "previews": [], "headers": [], @@ -9549,7 +9549,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9562,7 +9562,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9616,7 +9616,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9629,7 +9629,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9696,7 +9696,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9709,7 +9709,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9828,7 +9828,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9841,7 +9841,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9875,7 +9875,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists repositories the authenticated user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.", + "description": "Lists repositories the authenticated user has starred.\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.star+json`**: Includes a timestamp of when the star was created.", "documentationUrl": "https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user", "previews": [], "headers": [], @@ -9908,7 +9908,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9921,7 +9921,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -9971,7 +9971,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists repositories a user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.", + "description": "Lists repositories a user has starred.\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.star+json`**: Includes a timestamp of when the star was created.", "documentationUrl": "https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user", "previews": [], "headers": [], @@ -10017,7 +10017,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -10030,7 +10030,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -10084,7 +10084,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -10097,7 +10097,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -10131,7 +10131,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the people that have starred the repository.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.", + "description": "Lists the people that have starred the repository.\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.star+json`**: Includes a timestamp of when the star was created.", "documentationUrl": "https://docs.github.com/rest/activity/starring#list-stargazers", "previews": [], "headers": [], @@ -10164,7 +10164,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -10177,7 +10177,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -10226,7 +10226,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -10239,7 +10239,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -10313,7 +10313,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -10326,7 +10326,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -10481,6 +10481,39 @@ ], "renamed": null }, + { + "name": "Mark a thread as done", + "scope": "activity", + "id": "markThreadAsDone", + "method": "DELETE", + "url": "/notifications/threads/{thread_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.", + "documentationUrl": "https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "thread_id", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "No content", "examples": null } + ], + "renamed": null + }, { "name": "Mark a thread as read", "scope": "activity", @@ -10666,7 +10699,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", "documentationUrl": "https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user", "previews": [], "headers": [], @@ -10774,7 +10807,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.", "documentationUrl": "https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation", "previews": [], "headers": [], @@ -10831,7 +10864,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.", "documentationUrl": "https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation", "previews": [], "headers": [], @@ -10987,7 +11020,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. \n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nWhen using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. \n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app", "previews": [], "headers": [], @@ -11083,6 +11116,19 @@ "alias": null, "deprecated": null }, + { + "name": "permissions.codespaces", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "permissions.contents", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -11096,6 +11142,19 @@ "alias": null, "deprecated": null }, + { + "name": "permissions.dependabot_secrets", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "permissions.deployments", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11187,6 +11246,19 @@ "alias": null, "deprecated": null }, + { + "name": "permissions.repository_custom_properties", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "permissions.repository_hooks", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -11332,7 +11404,20 @@ }, { "name": "permissions.organization_custom_roles", - "description": "The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.", + "description": "The level of permission to grant the access token for custom repository roles management.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.organization_custom_org_roles", + "description": "The level of permission to grant the access token for custom organization roles management.", "in": "BODY", "type": "string", "required": false, @@ -11356,6 +11441,19 @@ "alias": null, "deprecated": null }, + { + "name": "permissions.organization_copilot_seat_management", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "permissions.organization_announcement_banners", "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", @@ -11369,6 +11467,19 @@ "alias": null, "deprecated": null }, + { + "name": "permissions.organization_events", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "permissions.organization_hooks", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -11498,6 +11609,97 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "permissions.email_addresses", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.followers", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.git_ssh_keys", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.gpg_keys", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.interaction_limits", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.profile", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.starring", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -11697,7 +11899,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", "documentationUrl": "https://docs.github.com/rest/apps/apps#get-an-app", "previews": [], "headers": [], @@ -12143,7 +12345,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12156,7 +12358,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12247,7 +12449,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12260,7 +12462,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12299,7 +12501,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.", + "description": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.", "documentationUrl": "https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-user-access-token", "previews": [], "headers": [], @@ -12319,7 +12521,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12332,7 +12534,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12376,7 +12578,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12389,7 +12591,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12509,14 +12711,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nYou must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.", + "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.", "documentationUrl": "https://docs.github.com/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12529,7 +12731,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12577,7 +12779,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12590,7 +12792,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12637,7 +12839,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12650,7 +12852,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12689,14 +12891,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List repositories that an app installation can access.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "description": "List repositories that an app installation can access.", "documentationUrl": "https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-app-installation", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12709,7 +12911,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12750,14 +12952,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps).", + "description": "Lists the active subscriptions for the authenticated user.", "documentationUrl": "https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12770,7 +12972,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12811,14 +13013,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps).", + "description": "Lists the active subscriptions for the authenticated user.", "documentationUrl": "https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12831,7 +13033,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12878,7 +13080,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -12989,7 +13191,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.", "documentationUrl": "https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation", "previews": [], "headers": [], @@ -13051,7 +13253,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.", "documentationUrl": "https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation", "previews": [], "headers": [], @@ -13164,7 +13366,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.", "documentationUrl": "https://docs.github.com/rest/apps/installations#revoke-an-installation-access-token", "previews": [], "headers": [], @@ -13181,7 +13383,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.\n\nYou must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)\nwhen accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App\nas the username and password.", "documentationUrl": "https://docs.github.com/rest/apps/apps#create-a-scoped-access-token", "previews": [], "headers": [], @@ -13316,6 +13518,19 @@ "alias": null, "deprecated": null }, + { + "name": "permissions.codespaces", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "permissions.contents", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -13329,6 +13544,19 @@ "alias": null, "deprecated": null }, + { + "name": "permissions.dependabot_secrets", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "permissions.deployments", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -13420,6 +13648,19 @@ "alias": null, "deprecated": null }, + { + "name": "permissions.repository_custom_properties", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "permissions.repository_hooks", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -13565,7 +13806,20 @@ }, { "name": "permissions.organization_custom_roles", - "description": "The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.", + "description": "The level of permission to grant the access token for custom repository roles management.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.organization_custom_org_roles", + "description": "The level of permission to grant the access token for custom organization roles management.", "in": "BODY", "type": "string", "required": false, @@ -13589,6 +13843,19 @@ "alias": null, "deprecated": null }, + { + "name": "permissions.organization_copilot_seat_management", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "permissions.organization_announcement_banners", "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", @@ -13602,6 +13869,19 @@ "alias": null, "deprecated": null }, + { + "name": "permissions.organization_events", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "permissions.organization_hooks", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -13731,6 +14011,97 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "permissions.email_addresses", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.followers", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.git_ssh_keys", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.gpg_keys", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.interaction_limits", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.profile", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.starring", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -13915,7 +14286,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `repo` or `admin:org` scope.", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization", "previews": [], "headers": [], @@ -13956,7 +14327,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `user` scope.", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user", "previews": [], "headers": [], @@ -13997,7 +14368,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.", + "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization", "previews": [], "headers": [], @@ -14038,7 +14409,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `user` scope.", + "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user", "previews": [], "headers": [], @@ -14079,7 +14450,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.", + "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization", "previews": [], "headers": [], @@ -14120,7 +14491,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `user` scope.", + "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user", "previews": [], "headers": [], @@ -14617,7 +14988,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nBy default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)\". Your GitHub App must have the `checks:write` permission to create check suites.", + "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "documentationUrl": "https://docs.github.com/rest/checks/suites#create-a-check-suite", "previews": [], "headers": [], @@ -14693,7 +15064,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Gets a single check run using its `id`.\n\n**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "documentationUrl": "https://docs.github.com/rest/checks/runs#get-a-check-run", "previews": [], "headers": [], @@ -14760,7 +15131,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "description": "Gets a single check suite using its `id`.\n\n**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "documentationUrl": "https://docs.github.com/rest/checks/suites#get-a-check-suite", "previews": [], "headers": [], @@ -14827,7 +15198,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.", + "description": "Lists annotations for a check run using the annotation `id`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "documentationUrl": "https://docs.github.com/rest/checks/runs#list-check-run-annotations", "previews": [], "headers": [], @@ -14873,7 +15244,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -14886,7 +15257,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -14920,7 +15291,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "documentationUrl": "https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference", "previews": [], "headers": [], @@ -15005,7 +15376,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -15018,7 +15389,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -15065,7 +15436,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", + "description": "Lists check runs for a check suite using its `id`.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "documentationUrl": "https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite", "previews": [], "headers": [], @@ -15150,7 +15521,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -15163,7 +15534,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -15197,7 +15568,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "documentationUrl": "https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference", "previews": [], "headers": [], @@ -15269,7 +15640,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -15282,7 +15653,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -15316,7 +15687,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".", + "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "documentationUrl": "https://docs.github.com/rest/checks/runs#rerequest-a-check-run", "previews": [], "headers": [], @@ -15390,7 +15761,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository.", + "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "documentationUrl": "https://docs.github.com/rest/checks/suites#rerequest-a-check-suite", "previews": [], "headers": [], @@ -15453,7 +15824,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", + "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.", "documentationUrl": "https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites", "previews": [], "headers": [], @@ -15546,7 +15917,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", + "description": "Updates a check run for a specific commit in a repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "documentationUrl": "https://docs.github.com/rest/checks/runs#update-a-check-run", "previews": [], "headers": [], @@ -15999,7 +16370,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", + "description": "Deletes a specified code scanning analysis from a repository.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository", "previews": [], "headers": [], @@ -16088,7 +16459,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "description": "Gets a single code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert", "previews": [], "headers": [], @@ -16176,7 +16547,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).", + "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\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/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository", "previews": [], "headers": [], @@ -16259,7 +16630,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nFor private repositories, you must use an access token with the `security_events` scope.\nFor public repositories, you can use tokens with the `security_events` or `public_repo` scope.\nGitHub Apps must have the `contents` read permission to use this endpoint.", + "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository", "previews": [], "headers": [], @@ -16334,7 +16705,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a code scanning default setup configuration.\nYou must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo`\nscope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint.", + "description": "Gets a code scanning default setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration", "previews": [], "headers": [], @@ -16395,7 +16766,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository).\" You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository).\"\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload", "previews": [], "headers": [], @@ -16473,7 +16844,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all instances of the specified code scanning alert.\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub Apps must have the `security_events` read permission to use this endpoint.", + "description": "Lists all instances of the specified code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert", "previews": [], "headers": [], @@ -16519,7 +16890,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -16532,7 +16903,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -16586,7 +16957,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization", "previews": [], "headers": [], @@ -16632,7 +17003,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -16645,7 +17016,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -16658,7 +17029,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -16671,7 +17042,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -16933,7 +17304,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all instances of the specified code scanning alert.\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub Apps must have the `security_events` read permission to use this endpoint.", + "description": "Lists all instances of the specified code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert", "previews": [], "headers": [], @@ -16979,7 +17350,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -16992,7 +17363,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -17051,7 +17422,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the CodeQL databases that are available in a repository.\n\nFor private repositories, you must use an access token with the `security_events` scope.\nFor public repositories, you can use tokens with the `security_events` or `public_repo` scope.\nGitHub Apps must have the `contents` read permission to use this endpoint.", + "description": "Lists the CodeQL databases that are available in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository", "previews": [], "headers": [], @@ -17112,7 +17483,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository", "previews": [], "headers": [], @@ -17171,7 +17542,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -17184,7 +17555,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -17277,7 +17648,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint.", + "description": "Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert", "previews": [], "headers": [], @@ -17390,7 +17761,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates a code scanning default setup configuration.\nYou must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo`\nscope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint.", + "description": "Updates a code scanning default setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration", "previews": [], "headers": [], @@ -17423,10 +17794,10 @@ }, { "name": "state", - "description": "Whether code scanning default setup has been configured or not.", + "description": "The desired state of code scanning default setup.", "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": ["configured", "not-configured"], "allowNull": false, "mapToData": null, @@ -17500,7 +17871,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data", "previews": [], "headers": [], @@ -17546,14 +17917,14 @@ }, { "name": "ref", - "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/tags/`, `refs/pull//merge`, or `refs/pull//head`.", "in": "BODY", "type": "string", "required": true, "enum": null, "allowNull": false, "mapToData": null, - "validation": null, + "validation": "^refs/(heads|tags|pull)/.*$", "alias": null, "deprecated": null }, @@ -17715,7 +18086,7 @@ "description": "Response", "examples": [ { - "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\n to any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\",\"html_url\":\"http://contributor-covenant.org/version/1/4/\"}" + "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\n to any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\\n\",\"html_url\":\"http://contributor-covenant.org/version/1/4/\"}" } ] }, @@ -17733,7 +18104,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Adds a repository to the selected repositories for a user's codespace secret.\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint.", + "description": "Adds a repository to the selected repositories for a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret", "previews": [], "headers": [], @@ -17791,7 +18162,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret", "previews": [], "headers": [], @@ -17865,7 +18236,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "description": "Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user", "previews": [], "headers": [], @@ -17954,7 +18325,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List the machine types a codespace can transition to use.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.", + "description": "List the machine types a codespace can transition to use.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace", "previews": [], "headers": [], @@ -18004,7 +18375,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a new codespace, owned by the authenticated user.\n\nThis endpoint requires either a `repository_id` OR a `pull_request` but not both.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "description": "Creates a new codespace, owned by the authenticated user.\n\nThis endpoint requires either a `repository_id` OR a `pull_request` but not both.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user", "previews": [], "headers": [], @@ -18244,7 +18615,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nYou must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint.", + "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret", "previews": [], "headers": [], @@ -18357,7 +18728,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nYou must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets`\nrepository permission to use this endpoint.", + "description": "Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret", "previews": [], "headers": [], @@ -18451,7 +18822,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.", + "description": "Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user", "previews": [], "headers": [], @@ -18538,7 +18909,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a codespace owned by the authenticated user for the specified pull request.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "description": "Creates a codespace owned by the authenticated user for the specified pull request.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request", "previews": [], "headers": [], @@ -18752,7 +19123,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a codespace owned by the authenticated user in the specified repository.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "description": "Creates a codespace owned by the authenticated user in the specified repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository", "previews": [], "headers": [], @@ -18968,7 +19339,7 @@ "isDeprecated": true, "deprecationDate": null, "removalDate": null, - "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nYou must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint.", + "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization", "previews": [], "headers": [], @@ -19031,7 +19402,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "description": "Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user", "previews": [], "headers": [], @@ -19077,7 +19448,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a user's codespace.\n\nTo use this endpoint you must authenticate using one of the following methods:\n\n- An access token with the `admin:org` scope\n- An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces`", + "description": "Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization", "previews": [], "headers": [], @@ -19149,7 +19520,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes an organization secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "description": "Deletes an organization development environment secret using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret", "previews": [], "headers": [], @@ -19196,7 +19567,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.", + "description": "Deletes a development environment secret in a repository using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret", "previews": [], "headers": [], @@ -19253,7 +19624,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.", + "description": "Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user", "previews": [], "headers": [], @@ -19284,7 +19655,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.\n\nIf changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", + "description": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.\n\nIf changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user", "previews": [], "headers": [], @@ -19338,14 +19709,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the codespaces that a member of an organization has for repositories in that organization.\n\nYou must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint.", + "description": "Lists the codespaces that a member of an organization has for repositories in that organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -19358,7 +19729,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -19427,7 +19798,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets information about an export of a codespace.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", + "description": "Gets information about an export of a codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export", "previews": [], "headers": [], @@ -19482,7 +19853,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets information about a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.", + "description": "Gets information about a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user", "previews": [], "headers": [], @@ -19532,7 +19903,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key", "previews": [], "headers": [], @@ -19573,7 +19944,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets an organization secret without revealing its encrypted value.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "description": "Gets an organization development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret", "previews": [], "headers": [], @@ -19627,7 +19998,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -19654,7 +20025,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key", "previews": [], "headers": [], @@ -19708,7 +20079,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.", + "description": "Gets a single repository development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret", "previews": [], "headers": [], @@ -19775,7 +20146,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a secret available to a user's codespaces without revealing its encrypted value.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.", + "description": "Gets a development environment secret available to a user's codespaces without revealing its encrypted value.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user", "previews": [], "headers": [], @@ -19816,14 +20187,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files\nspecify launchpoint configurations for codespaces created within the repository.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.", + "description": "Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files\nspecify launchpoint configurations for codespaces created within the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -19836,7 +20207,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -19906,14 +20277,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the authenticated user's codespaces.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.", + "description": "Lists the authenticated user's codespaces.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -19926,7 +20297,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -19982,14 +20353,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the codespaces associated to a specified organization.\n\nYou must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint.", + "description": "Lists the codespaces associated to a specified organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -20002,7 +20373,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -20071,14 +20442,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the codespaces associated to a specified repository and the authenticated user.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.", + "description": "Lists the codespaces associated to a specified repository and the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -20091,7 +20462,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -20159,7 +20530,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all Codespaces secrets available at the organization-level without revealing their encrypted values.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "description": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets", "previews": [], "headers": [], @@ -20179,7 +20550,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -20192,7 +20563,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -20226,7 +20597,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.", + "description": "Lists all development environment secrets available in a repository without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets", "previews": [], "headers": [], @@ -20259,7 +20630,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -20272,7 +20643,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -20306,7 +20677,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List the repositories that have been granted the ability to use a user's codespace secret.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.", + "description": "List the repositories that have been granted the ability to use a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret", "previews": [], "headers": [], @@ -20355,14 +20726,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all secrets available for a user's Codespaces without revealing their\nencrypted values.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.", + "description": "Lists all development environment secrets available for a user's codespaces without revealing their\nencrypted values.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#list-secrets-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -20375,7 +20746,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -20409,7 +20780,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret", "previews": [], "headers": [], @@ -20442,7 +20813,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -20455,7 +20826,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -20490,7 +20861,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the default attributes for codespaces created by the user with the repository.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "description": "Gets the default attributes for codespaces created by the user with the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace", "previews": [], "headers": [], @@ -20577,7 +20948,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.\n\nThe codespace's token is granted write permissions to the repository, allowing the user to push their changes.\n\nThis will fail for a codespace that is already published, meaning it has an associated repository.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "description": "Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.\n\nThe codespace's token is granted write permissions to the repository, allowing the user to push their changes.\n\nThis will fail for a codespace that is already published, meaning it has an associated repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace", "previews": [], "headers": [], @@ -20656,7 +21027,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a repository from the selected repositories for a user's codespace secret.\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.", + "description": "Removes a repository from the selected repositories for a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret", "previews": [], "headers": [], @@ -20714,7 +21085,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret", "previews": [], "headers": [], @@ -20788,7 +21159,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List the machine types available for a given repository based on its configuration.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint.", + "description": "List the machine types available for a given repository based on its configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository", "previews": [], "headers": [], @@ -20890,7 +21261,7 @@ "isDeprecated": true, "deprecationDate": null, "removalDate": null, - "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nYou must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint.", + "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces", "previews": [], "headers": [], @@ -20971,7 +21342,7 @@ "isDeprecated": true, "deprecationDate": null, "removalDate": null, - "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nYou must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint.", + "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization", "previews": [], "headers": [], @@ -21034,7 +21405,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Select the repositories that will use a user's codespace secret.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.", + "description": "Select the repositories that will use a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret", "previews": [], "headers": [], @@ -21092,7 +21463,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret", "previews": [], "headers": [], @@ -21157,7 +21528,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Starts a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", + "description": "Starts a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user", "previews": [], "headers": [], @@ -21211,7 +21582,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Stops a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", + "description": "Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user", "previews": [], "headers": [], @@ -21260,7 +21631,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Stops a user's codespace.\n\nTo use this endpoint you must authenticate using one of the following methods:\n\n- An access token with the `admin:org` scope\n- An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces`", + "description": "Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user", "previews": [], "headers": [], @@ -21336,7 +21707,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.\n\nIf you specify a new machine type it will be applied the next time your codespace is started.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "description": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.\n\nIf you specify a new machine type it will be applied the next time your codespace is started.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user", "previews": [], "headers": [], @@ -21415,16 +21786,16 @@ "renamed": null }, { - "name": "Add teams to the Copilot for Business subscription for an organization", + "name": "Add teams to the Copilot subscription for an organization", "scope": "copilot", - "id": "addCopilotForBusinessSeatsForTeams", + "id": "addCopilotSeatsForTeams", "method": "POST", "url": "/orgs/{org}/copilot/billing/selected_teams", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note**: This endpoint is in beta and is subject to change.\n\n Purchases a GitHub Copilot for Business seat for all users within each specified team.\n 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)\".\n\n Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\n authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.\n\n In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.\n 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)\".\n 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)\".", - "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#add-teams-to-the-copilot-for-business-subscription-for-an-organization", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -21470,7 +21841,7 @@ { "code": 404, "description": "Resource not found", "examples": null }, { "code": 422, - "description": "Copilot for Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.", + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.", "examples": null }, { "code": 500, "description": "Internal Error", "examples": null } @@ -21478,16 +21849,16 @@ "renamed": null }, { - "name": "Add users to the Copilot for Business subscription for an organization", + "name": "Add users to the Copilot subscription for an organization", "scope": "copilot", - "id": "addCopilotForBusinessSeatsForUsers", + "id": "addCopilotSeatsForUsers", "method": "POST", "url": "/orgs/{org}/copilot/billing/selected_users", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot for Business seat for each user specified.\nThe 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)\".\n\nOnly organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.\nFor 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)\".\nFor 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)\".", - "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#add-users-to-the-copilot-for-business-subscription-for-an-organization", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -21533,7 +21904,7 @@ { "code": 404, "description": "Resource not found", "examples": null }, { "code": 422, - "description": "Copilot for Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.", + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.", "examples": null }, { "code": 500, "description": "Internal Error", "examples": null } @@ -21541,7 +21912,7 @@ "renamed": null }, { - "name": "Remove teams from the Copilot for Business subscription for an organization", + "name": "Remove teams from the Copilot subscription for an organization", "scope": "copilot", "id": "cancelCopilotSeatAssignmentForTeams", "method": "DELETE", @@ -21549,8 +21920,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot for Business seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor 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)\".\n\nFor more information about disabling access to Copilot for Business, see \"[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#remove-teams-from-the-copilot-for-business-subscription-for-an-organization", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -21596,7 +21967,7 @@ { "code": 404, "description": "Resource not found", "examples": null }, { "code": 422, - "description": "Copilot for Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.", + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.", "examples": null }, { "code": 500, "description": "Internal Error", "examples": null } @@ -21604,7 +21975,7 @@ "renamed": null }, { - "name": "Remove users from the Copilot for Business subscription for an organization", + "name": "Remove users from the Copilot subscription for an organization", "scope": "copilot", "id": "cancelCopilotSeatAssignmentForUsers", "method": "DELETE", @@ -21612,8 +21983,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot for Business seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor 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)\"\n\nFor more information about disabling access to Copilot for Business, see \"[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#remove-users-from-the-copilot-for-business-subscription-for-an-organization", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -21659,7 +22030,7 @@ { "code": 404, "description": "Resource not found", "examples": null }, { "code": 422, - "description": "Copilot for Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team.", + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team.", "examples": null }, { "code": 500, "description": "Internal Error", "examples": null } @@ -21667,7 +22038,7 @@ "renamed": null }, { - "name": "Get Copilot for Business seat information and settings for an organization", + "name": "Get Copilot seat information and settings for an organization", "scope": "copilot", "id": "getCopilotOrganizationDetails", "method": "GET", @@ -21675,8 +22046,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot for Business subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Configuring GitHub Copilot settings in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)\".\n\nOnly organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must\nauthenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-information-and-settings-for-an-organization", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can configure and view details about the organization's Copilot Business subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -21716,7 +22087,7 @@ "renamed": null }, { - "name": "Get Copilot for Business seat assignment details for a user", + "name": "Get Copilot seat assignment details for a user", "scope": "copilot", "id": "getCopilotSeatDetailsForUser", "method": "GET", @@ -21724,8 +22095,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-assignment-details-for-a-user", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners can view GitHub Copilot seat assignment details for members in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -21775,7 +22146,7 @@ { "code": 404, "description": "Resource not found", "examples": null }, { "code": 422, - "description": "Copilot for Business is not enabled for this organization or the user has a pending organization invitation.", + "description": "Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation.", "examples": null }, { "code": 500, "description": "Internal Error", "examples": null } @@ -21783,7 +22154,7 @@ "renamed": null }, { - "name": "List all Copilot for Business seat assignments for an organization", + "name": "List all Copilot seat assignments for an organization", "scope": "copilot", "id": "listCopilotSeats", "method": "GET", @@ -21791,8 +22162,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must\nauthenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#list-all-copilot-for-business-seat-assignments-for-an-organization", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -21811,7 +22182,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -21824,7 +22195,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -21866,7 +22237,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret", "previews": [], "headers": [], @@ -22041,7 +22412,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nYou must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository\npermission to use this endpoint.", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret", "previews": [], "headers": [], @@ -22135,7 +22506,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret", "previews": [], "headers": [], @@ -22179,7 +22550,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.", + "description": "Deletes a secret in a repository using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret", "previews": [], "headers": [], @@ -22236,7 +22607,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "You must use an access token with the `security_events` scope to use this endpoint with private repositories.\nYou can also use tokens with the `public_repo` scope for public repositories only.\nGitHub Apps must have **Dependabot alerts** read permission to use this endpoint.", + "description": "OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "documentationUrl": "https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert", "previews": [], "headers": [], @@ -22306,7 +22677,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key", "previews": [], "headers": [], @@ -22347,7 +22718,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret", "previews": [], "headers": [], @@ -22401,7 +22772,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets. Anyone with read access\nto the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private.", "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key", "previews": [], "headers": [], @@ -22455,7 +22826,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.", + "description": "Gets a single repository secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret", "previews": [], "headers": [], @@ -22522,7 +22893,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\nTo use this endpoint, you must be a member of the enterprise, and you must use an\naccess token with the `repo` scope or `security_events` scope.\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise", "previews": [], "headers": [], @@ -22633,7 +23004,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -22646,7 +23017,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -22685,7 +23056,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -22727,7 +23098,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists Dependabot alerts for an organization.\n\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have **Dependabot alerts** read permission to use this endpoint.", + "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "documentationUrl": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization", "previews": [], "headers": [], @@ -22838,7 +23209,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -22851,7 +23222,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -22890,7 +23261,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -22934,7 +23305,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "You must use an access token with the `security_events` scope to use this endpoint with private repositories.\nYou can also use tokens with the `public_repo` scope for public repositories only.\nGitHub Apps must have **Dependabot alerts** read permission to use this endpoint.", + "description": "OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "documentationUrl": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository", "previews": [], "headers": [], @@ -23084,7 +23455,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -23097,7 +23468,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -23110,7 +23481,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -23180,7 +23551,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets", "previews": [], "headers": [], @@ -23200,7 +23571,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -23213,7 +23584,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -23247,7 +23618,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.", + "description": "Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#list-repository-secrets", "previews": [], "headers": [], @@ -23280,7 +23651,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -23293,7 +23664,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -23327,7 +23698,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret", "previews": [], "headers": [], @@ -23360,7 +23731,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -23373,7 +23744,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -23407,7 +23778,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret", "previews": [], "headers": [], @@ -23475,7 +23846,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret", "previews": [], "headers": [], @@ -23532,7 +23903,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "You must use an access token with the `security_events` scope to use this endpoint with private repositories.\nYou can also use tokens with the `public_repo` scope for public repositories only.\nGitHub Apps must have **Dependabot alerts** write permission to use this endpoint.\n\nTo use this endpoint, you must have access to security alerts for the repository. For more information, see \"[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"", + "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "documentationUrl": "https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert", "previews": [], "headers": [], @@ -23654,7 +24025,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to.", + "description": "Create a new snapshot of a repository's dependencies.\n\nThe authenticated user must have access to the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository", "previews": [], "headers": [], @@ -24400,7 +24771,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", + "description": "Creates a comment on a gist.\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.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "documentationUrl": "https://docs.github.com/rest/gists/comments#create-a-gist-comment", "previews": [], "headers": [], @@ -24591,7 +24962,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", + "description": "Gets a specified gist.\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.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "documentationUrl": "https://docs.github.com/rest/gists/gists#get-a-gist", "previews": [], "headers": [], @@ -24635,7 +25006,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", + "description": "Gets a comment on a gist.\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.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "documentationUrl": "https://docs.github.com/rest/gists/comments#get-a-gist-comment", "previews": [], "headers": [], @@ -24692,7 +25063,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", + "description": "Gets a specified gist revision.\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.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "documentationUrl": "https://docs.github.com/rest/gists/gists#get-a-gist-revision", "previews": [], "headers": [], @@ -24773,7 +25144,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -24786,7 +25157,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -24822,7 +25193,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", + "description": "Lists the comments on a gist.\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.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "documentationUrl": "https://docs.github.com/rest/gists/comments#list-gist-comments", "previews": [], "headers": [], @@ -24842,7 +25213,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -24855,7 +25226,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -24912,7 +25283,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -24925,7 +25296,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -24995,7 +25366,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -25008,7 +25379,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -25067,7 +25438,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -25080,7 +25451,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -25117,7 +25488,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", + "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", "documentationUrl": "https://docs.github.com/rest/gists/gists#list-public-gists", "previews": [], "headers": [], @@ -25137,7 +25508,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -25150,7 +25521,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -25211,7 +25582,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -25224,7 +25595,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -25265,7 +25636,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", "documentationUrl": "https://docs.github.com/rest/gists/gists#star-a-gist", "previews": [], "headers": [], @@ -25455,7 +25826,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", + "description": "Updates a comment on a gist.\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.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "documentationUrl": "https://docs.github.com/rest/gists/comments#update-a-gist-comment", "previews": [], "headers": [], @@ -26291,7 +26662,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "The `content` in the response will always be Base64 encoded.\n\n_Note_: This API supports blobs up to 100 megabytes in size.", + "description": "The `content` in the response will always be Base64 encoded.\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.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", "documentationUrl": "https://docs.github.com/rest/git/blobs#get-a-blob", "previews": [], "headers": [], @@ -26851,7 +27222,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "The API also allows fetching the source of a single template.\nUse the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents.", + "description": "Get the content of a gitignore template.\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.raw+json`**: Returns the raw .gitignore contents.", "documentationUrl": "https://docs.github.com/rest/gitignore/gitignore#get-a-gitignore-template", "previews": [], "headers": [], @@ -27822,7 +28193,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/issues/issues#create-an-issue", "previews": [], "headers": [], @@ -27965,7 +28336,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "\nYou can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nSee \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\"\nand \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\"\nfor details.", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/issues/comments#create-an-issue-comment", "previews": [], "headers": [], @@ -28438,7 +28809,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/issues/issues#get-an-issue", "previews": [], "headers": [], @@ -28509,7 +28880,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.", + "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/issues/comments#get-an-issue-comment", "previews": [], "headers": [], @@ -28783,7 +29154,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.", + "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], @@ -28927,7 +29298,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -28940,7 +29311,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29014,7 +29385,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29027,7 +29398,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29062,7 +29433,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.", + "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/issues/comments#list-issue-comments", "previews": [], "headers": [], @@ -29121,7 +29492,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29134,7 +29505,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29170,7 +29541,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.", + "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository", "previews": [], "headers": [], @@ -29242,7 +29613,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29255,7 +29626,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29341,7 +29712,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29354,7 +29725,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29422,7 +29793,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29435,7 +29806,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29520,7 +29891,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29533,7 +29904,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29569,7 +29940,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.", + "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], @@ -29661,7 +30032,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29674,7 +30045,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29710,7 +30081,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.", + "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], @@ -29815,7 +30186,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29828,7 +30199,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -29863,7 +30234,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.", + "description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/issues/issues#list-repository-issues", "previews": [], "headers": [], @@ -30013,7 +30384,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -30026,7 +30397,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -30113,7 +30484,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -30126,7 +30497,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -30193,7 +30564,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -30206,7 +30577,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -30287,7 +30658,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -30300,7 +30671,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -30409,7 +30780,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -30422,7 +30793,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -30457,7 +30828,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", "documentationUrl": "https://docs.github.com/rest/issues/issues#lock-an-issue", "previews": [], "headers": [], @@ -30924,7 +31295,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Issue owners and users with push access can edit an issue.", + "description": "Issue owners and users with push access can edit an issue.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/issues/issues#update-an-issue", "previews": [], "headers": [], @@ -31105,7 +31476,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.", + "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/issues/comments#update-an-issue-comment", "previews": [], "headers": [], @@ -31479,7 +31850,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -31492,7 +31863,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -31527,7 +31898,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.", + "description": "This method returns the contents of the repository's license file, if one is detected.\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.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "documentationUrl": "https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository", "previews": [], "headers": [], @@ -32390,7 +32761,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -32403,7 +32774,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -32464,7 +32835,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -32477,7 +32848,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -32544,7 +32915,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -32557,7 +32928,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -32625,7 +32996,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -32638,7 +33009,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -32693,7 +33064,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -32706,7 +33077,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -33609,7 +33980,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nTo use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope.\n\nGitHub Apps must have the `administration` organization read-write permission to use this endpoint.", + "description": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team", "previews": [], "headers": [], @@ -33651,6 +34022,144 @@ ], "renamed": null }, + { + "name": "Assign an organization role to a team", + "scope": "orgs", + "id": "assignTeamToOrgRole", + "method": "PUT", + "url": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 404, + "description": "Response if the organization, team or role does not exist.", + "examples": null + }, + { + "code": 422, + "description": "Response if the organization roles feature is not enabled for the organization, or validation failed.", + "examples": null + } + ], + "renamed": null + }, + { + "name": "Assign an organization role to a user", + "scope": "orgs", + "id": "assignUserToOrgRole", + "method": "PUT", + "url": "/orgs/{org}/organization-roles/users/{username}/{role_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 404, + "description": "Response if the organization, user or role does not exist.", + "examples": null + }, + { + "code": 422, + "description": "Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member.", + "examples": null + } + ], + "renamed": null + }, { "name": "Block a user from an organization", "scope": "orgs", @@ -33995,16 +34504,16 @@ "renamed": null }, { - "name": "Create an organization invitation", + "name": "Create a custom organization role", "scope": "orgs", - "id": "createInvitation", + "id": "createCustomOrganizationRole", "method": "POST", - "url": "/orgs/{org}/invitations", + "url": "/orgs/{org}/organization-roles", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/rest/orgs/members#create-an-organization-invitation", + "description": "Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#create-a-custom-organization-role", "previews": [], "headers": [], "parameters": [ @@ -34022,24 +34531,11 @@ "deprecated": null }, { - "name": "invitee_id", - "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "email", - "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user.", + "name": "name", + "description": "The name of the custom role.", "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -34048,12 +34544,12 @@ "deprecated": null }, { - "name": "role", - "description": "The role for the new member. \n * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.", + "name": "description", + "description": "A short description about the intended usage of this role or what permissions it grants.", "in": "BODY", "type": "string", "required": false, - "enum": ["admin", "direct_member", "billing_manager"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -34061,11 +34557,11 @@ "deprecated": null }, { - "name": "team_ids", - "description": "Specify IDs for the teams you want to invite new members to.", + "name": "permissions", + "description": "A list of additional permissions included in this role.", "in": "BODY", - "type": "integer[]", - "required": false, + "type": "string[]", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -34080,11 +34576,12 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\",\"invitation_source\":\"member\"}" + "data": "{\"id\":8030,\"name\":\"Custom Role Manager\",\"description\":\"Permissions to manage custom roles within an org\",\"permissions\":[\"write_organization_custom_repo_role\",\"write_organization_custom_org_role\",\"read_organization_custom_repo_role\",\"read_organization_custom_org_role\"],\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"created_at\":\"2022-07-04T22:19:11Z\",\"updated_at\":\"2022-07-04T22:19:11Z\"}" } ] }, { "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.", @@ -34094,16 +34591,16 @@ "renamed": null }, { - "name": "Create or update custom properties for an organization", + "name": "Create an organization invitation", "scope": "orgs", - "id": "createOrUpdateCustomProperties", - "method": "PATCH", - "url": "/orgs/{org}/properties/schema", + "id": "createInvitation", + "method": "POST", + "url": "/orgs/{org}/invitations", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates new or updates existing custom properties defined for an organization in a batch.\nOnly organization owners (or users with the proper permissions granted by them) can update these properties", - "documentationUrl": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization", + "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "documentationUrl": "https://docs.github.com/rest/orgs/members#create-an-organization-invitation", "previews": [], "headers": [], "parameters": [ @@ -34121,49 +34618,10 @@ "deprecated": null }, { - "name": "properties", - "description": "The array of custom properties to create or update.", - "in": "BODY", - "type": "object[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "properties[].property_name", - "description": "The name of the property", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "properties[].value_type", - "description": "The type of the value for the property", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["string", "single_select"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "properties[].required", - "description": "Whether the property is required.", + "name": "invitee_id", + "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting.", "in": "BODY", - "type": "boolean", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -34173,39 +34631,39 @@ "deprecated": null }, { - "name": "properties[].default_value", - "description": "Default value of the property", + "name": "email", + "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user.", "in": "BODY", "type": "string", "required": false, "enum": null, - "allowNull": true, + "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "properties[].description", - "description": "Short description of the property", + "name": "role", + "description": "The role for the new member. \n * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. \n * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization.", "in": "BODY", "type": "string", "required": false, - "enum": null, - "allowNull": true, + "enum": ["admin", "direct_member", "billing_manager", "reinstate"], + "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "properties[].allowed_values", - "description": "Ordered list of allowed values of the property", + "name": "team_ids", + "description": "Specify IDs for the teams you want to invite new members to.", "in": "BODY", - "type": "string[]", + "type": "integer[]", "required": false, "enum": null, - "allowNull": true, + "allowNull": false, "mapToData": null, "validation": null, "alias": null, @@ -34214,30 +34672,34 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "Response", "examples": [ { - "data": "[{\"property_name\":\"environment\",\"value_type\":\"single_select\",\"required\":true,\"default_value\":\"production\",\"description\":\"Prod or dev environment\",\"allowed_values\":[\"production\",\"development\"]},{\"property_name\":\"service\",\"value_type\":\"string\"},{\"property_name\":\"team\",\"value_type\":\"string\",\"description\":\"Team owning the repository\"}]" + "data": "{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\",\"invitation_source\":\"member\"}" } ] }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } ], "renamed": null }, { - "name": "Create or update custom property values for organization repositories", + "name": "Create or update custom properties for an organization", "scope": "orgs", - "id": "createOrUpdateCustomPropertiesValuesForRepos", + "id": "createOrUpdateCustomProperties", "method": "PATCH", - "url": "/orgs/{org}/properties/values", + "url": "/orgs/{org}/properties/schema", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nOnly organization owners (or users with the proper permissions granted by them) can update these properties", - "documentationUrl": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories", + "description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "documentationUrl": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -34254,22 +34716,169 @@ "alias": null, "deprecated": null }, - { - "name": "repository_names", - "description": "The names of repositories that the custom property values will be applied to.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "properties", - "description": "List of custom property names and associated values to apply to the repositories.", + "description": "The array of custom properties to create or update.", + "in": "BODY", + "type": "object[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].property_name", + "description": "The name of the property", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].value_type", + "description": "The type of the value for the property", + "in": "BODY", + "type": "string", + "required": true, + "enum": ["string", "single_select"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].required", + "description": "Whether the property is required.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].default_value", + "description": "Default value of the property", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].description", + "description": "Short description of the property", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].allowed_values", + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].values_editable_by", + "description": "Who can edit the values of the property", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["org_actors", "org_and_repo_actors"], + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"property_name\":\"environment\",\"value_type\":\"single_select\",\"required\":true,\"default_value\":\"production\",\"description\":\"Prod or dev environment\",\"allowed_values\":[\"production\",\"development\"],\"values_editable_by\":\"org_actors\"},{\"property_name\":\"service\",\"value_type\":\"string\"},{\"property_name\":\"team\",\"value_type\":\"string\",\"description\":\"Team owning the repository\"}]" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Create or update custom property values for organization repositories", + "scope": "orgs", + "id": "createOrUpdateCustomPropertiesValuesForRepos", + "method": "PATCH", + "url": "/orgs/{org}/properties/values", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.", + "documentationUrl": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repository_names", + "description": "The names of repositories that the custom property values will be applied to.", + "in": "BODY", + "type": "string[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties", + "description": "List of custom property names and associated values to apply to the repositories.", "in": "BODY", "type": "object[]", "required": true, @@ -34297,7 +34906,7 @@ "name": "properties[].value", "description": "The value assigned to the property", "in": "BODY", - "type": "string", + "type": null, "required": true, "enum": null, "allowNull": true, @@ -34314,7 +34923,12 @@ "examples": null }, { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } ], "renamed": null }, @@ -34327,7 +34941,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a new or updates an existing custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.", + "description": "Creates a new or updates an existing custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", "documentationUrl": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization", "previews": [], "headers": [], @@ -34412,7 +35026,7 @@ }, { "name": "allowed_values", - "description": "Ordered list of allowed values of the property", + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.", "in": "BODY", "type": "string[]", "required": false, @@ -34655,6 +35269,50 @@ ], "renamed": null }, + { + "name": "Delete a custom organization role.", + "scope": "orgs", + "id": "deleteCustomOrganizationRole", + "method": "DELETE", + "url": "/orgs/{org}/organization-roles/{role_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Deletes a custom organization role. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#delete-a-custom-organization-role", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], + "renamed": null + }, { "name": "Delete an organization webhook", "scope": "orgs", @@ -34711,7 +35369,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Enables or disables the specified security feature for all eligible repositories in an organization.\n\nTo use this endpoint, you must be an organization owner or be member of a team with the security manager role.\nA token with the 'write:org' scope is also required.\n\nGitHub Apps must have the `organization_administration:write` permission to use this endpoint.\n\nFor more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization", "previews": [], "headers": [], @@ -34796,7 +35454,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub plan information' below.\"", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.", "documentationUrl": "https://docs.github.com/rest/orgs/orgs#get-an-organization", "previews": [], "headers": [], @@ -34821,7 +35479,7 @@ "description": "Response", "examples": [ { - "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"filled_seats\":4,\"seats\":5},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"members_can_fork_private_repositories\":false,\"web_commit_signoff_required\":false,\"updated_at\":\"2014-03-03T18:58:10Z\",\"archived_at\":null,\"dependency_graph_enabled_for_new_repositories\":false,\"dependabot_alerts_enabled_for_new_repositories\":false,\"dependabot_security_updates_enabled_for_new_repositories\":false,\"advanced_security_enabled_for_new_repositories\":false,\"secret_scanning_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_custom_link\":\"https://github.com/octo-org/octo-repo/blob/main/im-blocked.md\",\"secret_scanning_push_protection_custom_link_enabled\":false}" + "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"filled_seats\":4,\"seats\":5},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"members_can_fork_private_repositories\":false,\"web_commit_signoff_required\":false,\"updated_at\":\"2014-03-03T18:58:10Z\",\"dependency_graph_enabled_for_new_repositories\":false,\"dependabot_alerts_enabled_for_new_repositories\":false,\"dependabot_security_updates_enabled_for_new_repositories\":false,\"advanced_security_enabled_for_new_repositories\":false,\"secret_scanning_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_custom_link\":\"https://github.com/octo-org/octo-repo/blob/main/im-blocked.md\",\"secret_scanning_push_protection_custom_link_enabled\":false}" } ] }, @@ -34838,7 +35496,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets all custom properties defined for an organization.\nYou must be an organization owner to use this endpoint.", + "description": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.", "documentationUrl": "https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization", "previews": [], "headers": [], @@ -34863,7 +35521,7 @@ "description": "Response", "examples": [ { - "data": "[{\"property_name\":\"environment\",\"value_type\":\"single_select\",\"required\":true,\"default_value\":\"production\",\"description\":\"Prod or dev environment\",\"allowed_values\":[\"production\",\"development\"]},{\"property_name\":\"service\",\"value_type\":\"string\"},{\"property_name\":\"team\",\"value_type\":\"string\",\"description\":\"Team owning the repository\"}]" + "data": "[{\"property_name\":\"environment\",\"value_type\":\"single_select\",\"required\":true,\"default_value\":\"production\",\"description\":\"Prod or dev environment\",\"allowed_values\":[\"production\",\"development\"],\"values_editable_by\":\"org_actors\"},{\"property_name\":\"service\",\"value_type\":\"string\"},{\"property_name\":\"team\",\"value_type\":\"string\",\"description\":\"Team owning the repository\"}]" } ] }, @@ -34881,7 +35539,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.", + "description": "Gets a custom property that is defined for an organization.\nOrganization members can read these properties.", "documentationUrl": "https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization", "previews": [], "headers": [], @@ -35027,6 +35685,66 @@ ], "renamed": null }, + { + "name": "Get an organization role", + "scope": "orgs", + "id": "getOrgRole", + "method": "GET", + "url": "/orgs/{org}/organization-roles/{role_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":8030,\"name\":\"Custom Role Manager\",\"description\":\"Permissions to manage custom roles within an org\",\"permissions\":[\"write_organization_custom_repo_role\",\"write_organization_custom_org_role\",\"read_organization_custom_repo_role\",\"read_organization_custom_org_role\"],\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"created_at\":\"2022-07-04T22:19:11Z\",\"updated_at\":\"2022-07-04T22:20:11Z\"}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, { "name": "Get an organization webhook", "scope": "orgs", @@ -35091,7 +35809,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\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.", + "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.", "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization", "previews": [], "headers": [], @@ -35239,7 +35957,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35274,7 +35992,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.", + "description": "Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization", "previews": [], "headers": [], @@ -35294,7 +36012,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35307,7 +36025,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35361,7 +36079,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35374,7 +36092,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35428,7 +36146,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35441,7 +36159,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35510,7 +36228,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35523,7 +36241,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35558,14 +36276,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List organizations for the authenticated user.\n\n**OAuth scope requirements**\n\nThis only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.", + "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.", "documentationUrl": "https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35578,7 +36296,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35639,7 +36357,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35652,7 +36370,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35719,7 +36437,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35732,7 +36450,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35813,7 +36531,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35826,7 +36544,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35885,7 +36603,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35898,7 +36616,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35935,6 +36653,280 @@ ], "renamed": null }, + { + "name": "List teams that are assigned to an organization role", + "scope": "orgs", + "id": "listOrgRoleTeams", + "method": "GET", + "url": "/orgs/{org}/organization-roles/{role_id}/teams", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response - List of assigned teams", + "examples": [ + { + "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" + } + ] + }, + { + "code": 404, + "description": "Response if the organization or role does not exist.", + "examples": null + }, + { + "code": 422, + "description": "Response if the organization roles feature is not enabled or validation failed.", + "examples": null + } + ], + "renamed": null + }, + { + "name": "List users that are assigned to an organization role", + "scope": "orgs", + "id": "listOrgRoleUsers", + "method": "GET", + "url": "/orgs/{org}/organization-roles/{role_id}/users", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response - List of assigned users", + "examples": [ + { + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + } + ] + }, + { + "code": 404, + "description": "Response if the organization or role does not exist.", + "examples": null + }, + { + "code": 422, + "description": "Response if the organization roles feature is not enabled or validation failed.", + "examples": null + } + ], + "renamed": null + }, + { + "name": "Get all organization roles for an organization", + "scope": "orgs", + "id": "listOrgRoles", + "method": "GET", + "url": "/orgs/{org}/organization-roles", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response - list of organization roles", + "examples": [ + { + "data": "{\"total_count\":2,\"roles\":[{\"id\":8030,\"name\":\"Custom Role Manager\",\"description\":\"Permissions to manage custom roles within an org\",\"permissions\":[\"write_organization_custom_repo_role\",\"write_organization_custom_org_role\",\"read_organization_custom_repo_role\",\"read_organization_custom_org_role\"],\"organization\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"created_at\":\"2022-07-04T22:19:11Z\",\"updated_at\":\"2022-07-04T22:20:11Z\"},{\"id\":8031,\"name\":\"Auditor\",\"description\":\"Permissions to read the organization audit log\",\"permissions\":[\"read_audit_logs\"],\"organization\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"created_at\":\"2022-07-04T22:19:11Z\",\"updated_at\":\"2022-07-04T22:20:11Z\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, + { + "name": "List organization fine-grained permissions for an organization", + "scope": "orgs", + "id": "listOrganizationFineGrainedPermissions", + "method": "GET", + "url": "/orgs/{org}/organization-fine-grained-permissions", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo list the fine-grained permissions that can be used in custom repository roles for an organization, see \"[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"name\":\"read_organization_custom_org_role\",\"description\":\"View organization roles\"},{\"name\":\"write_organization_custom_org_role\",\"description\":\"Manage custom organization roles\"}]" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, { "name": "List outside collaborators for an organization", "scope": "orgs", @@ -35977,7 +36969,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -35990,7 +36982,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36024,7 +37016,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API,\nusing the `organization_personal_access_tokens: read` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "description": "Lists the repositories a fine-grained personal access token has access to.\n\nOnly GitHub Apps can use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to", "previews": [], "headers": [], @@ -36057,7 +37049,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36070,7 +37062,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36107,7 +37099,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API,\nusing the `organization_personal_access_token_requests: read` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "description": "Lists the repositories a fine-grained personal access token request is requesting access to.\n\nOnly GitHub Apps can use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token", "previews": [], "headers": [], @@ -36140,7 +37132,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36153,7 +37145,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36190,7 +37182,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the `organization_personal_access_token_requests: read` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "description": "Lists requests from organization members to access organization resources with a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens", "previews": [], "headers": [], @@ -36210,7 +37202,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36223,7 +37215,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36356,7 +37348,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API,\nusing the `organization_personal_access_tokens: read` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "description": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.\n\nOnly GitHub Apps can use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources", "previews": [], "headers": [], @@ -36376,7 +37368,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36389,7 +37381,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36542,7 +37534,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36555,7 +37547,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36642,7 +37634,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36655,7 +37647,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36689,7 +37681,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope.\n\nGitHub Apps must have the `administration` organization read permission to use this endpoint.", + "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams", "previews": [], "headers": [], @@ -36763,7 +37755,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36850,7 +37842,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36863,7 +37855,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -36889,6 +37881,106 @@ ], "renamed": null }, + { + "name": "Update a custom organization role", + "scope": "orgs", + "id": "patchCustomOrganizationRole", + "method": "PATCH", + "url": "/orgs/{org}/organization-roles/{role_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#update-a-custom-organization-role", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name", + "description": "The name of the custom role.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "description", + "description": "A short description about the intended usage of this role or what permissions it grants.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions", + "description": "A list of additional permissions included in this role.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":8030,\"name\":\"Custom Role Manager\",\"description\":\"Permissions to manage custom roles within an org\",\"permissions\":[\"write_organization_custom_repo_role\",\"write_organization_custom_org_role\",\"read_organization_custom_repo_role\",\"read_organization_custom_org_role\"],\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"created_at\":\"2022-07-04T22:19:11Z\",\"updated_at\":\"2022-07-04T22:19:11Z\"}" + } + ] + }, + { "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.", + "examples": null + } + ], + "renamed": null + }, { "name": "Ping an organization webhook", "scope": "orgs", @@ -37015,7 +38107,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.", + "description": "Removes a custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", "documentationUrl": "https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization", "previews": [], "headers": [], @@ -37261,7 +38353,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nTo use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.\n\nGitHub Apps must have the `administration` organization read-write permission to use this endpoint.", + "description": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team", "previews": [], "headers": [], @@ -37305,7 +38397,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the `organization_personal_access_token_requests: write` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "description": "Approves or denies a pending request to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token", "previews": [], "headers": [], @@ -37389,7 +38481,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the `organization_personal_access_token_requests: write` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "description": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens", "previews": [], "headers": [], @@ -37465,16 +38557,60 @@ "renamed": null }, { - "name": "Set organization membership for a user", + "name": "Remove all organization roles for a team", "scope": "orgs", - "id": "setMembershipForUser", - "method": "PUT", - "url": "/orgs/{org}/memberships/{username}", + "id": "revokeAllOrgRolesTeam", + "method": "DELETE", + "url": "/orgs/{org}/organization-roles/teams/{team_slug}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", - "documentationUrl": "https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user", + "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Remove all organization roles for a user", + "scope": "orgs", + "id": "revokeAllOrgRolesUser", + "method": "DELETE", + "url": "/orgs/{org}/organization-roles/users/{username}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -37503,14 +38639,58 @@ "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Remove an organization role from a team", + "scope": "orgs", + "id": "revokeOrgRoleTeam", + "method": "DELETE", + "url": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Removes an organization role from a team. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null }, { - "name": "role", - "description": "The role to give the user in the organization. Can be one of: \n * `admin` - The user will become an owner of the organization. \n * `member` - The user will become a non-owner member of the organization.", - "in": "BODY", + "name": "team_slug", + "description": "The slug of the team name.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["admin", "member"], + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -37518,36 +38698,150 @@ "deprecated": null } ], - "responses": [ + "responses": [{ "code": 204, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Remove an organization role from a user", + "scope": "orgs", + "id": "revokeOrgRoleUser", + "method": "DELETE", + "url": "/orgs/{org}/organization-roles/users/{username}/{role_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Remove an organization role from a user. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user", + "previews": [], + "headers": [], + "parameters": [ { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/orgs/octocat/memberships/defunkt\",\"state\":\"active\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/octocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"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}}" - } - ] + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null }, - { "code": 403, "description": "Forbidden", "examples": null }, { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], "renamed": null }, { - "name": "Set public organization membership for the authenticated user", + "name": "Set organization membership for a user", "scope": "orgs", - "id": "setPublicMembershipForAuthenticatedUser", + "id": "setMembershipForUser", "method": "PUT", - "url": "/orgs/{org}/public_members/{username}", + "url": "/orgs/{org}/memberships/{username}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "documentationUrl": "https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "role", + "description": "The role to give the user in the organization. Can be one of: \n * `admin` - The user will become an owner of the organization. \n * `member` - The user will become a non-owner member of the organization.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["admin", "member"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/orgs/octocat/memberships/defunkt\",\"state\":\"active\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/octocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, + { + "name": "Set public organization membership for the authenticated user", + "scope": "orgs", + "id": "setPublicMembershipForAuthenticatedUser", + "method": "PUT", + "url": "/orgs/{org}/public_members/{username}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "documentationUrl": "https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -37637,7 +38931,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges.", + "description": "**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/orgs#update-an-organization", "previews": [], "headers": [], @@ -38039,7 +39333,7 @@ "description": "Response", "examples": [ { - "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"filled_seats\":4,\"seats\":5},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"members_can_fork_private_repositories\":false,\"web_commit_signoff_required\":false,\"updated_at\":\"2014-03-03T18:58:10Z\",\"archived_at\":null,\"dependency_graph_enabled_for_new_repositories\":false,\"dependabot_alerts_enabled_for_new_repositories\":false,\"dependabot_security_updates_enabled_for_new_repositories\":false,\"advanced_security_enabled_for_new_repositories\":false,\"secret_scanning_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_custom_link\":\"https://github.com/octo-org/octo-repo/blob/main/im-blocked.md\",\"secret_scanning_push_protection_custom_link_enabled\":false}" + "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"filled_seats\":4,\"seats\":5},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"members_can_fork_private_repositories\":false,\"web_commit_signoff_required\":false,\"updated_at\":\"2014-03-03T18:58:10Z\",\"dependency_graph_enabled_for_new_repositories\":false,\"dependabot_alerts_enabled_for_new_repositories\":false,\"dependabot_security_updates_enabled_for_new_repositories\":false,\"advanced_security_enabled_for_new_repositories\":false,\"secret_scanning_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_custom_link\":\"https://github.com/octo-org/octo-repo/blob/main/im-blocked.md\",\"secret_scanning_push_protection_custom_link_enabled\":false}" } ] }, @@ -38118,7 +39412,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API,\nusing the `organization_personal_access_tokens: write` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "description": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources", "previews": [], "headers": [], @@ -38189,7 +39483,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API,\nusing the `organization_personal_access_tokens: write` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "description": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens", "previews": [], "headers": [], @@ -38424,7 +39718,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\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.", + "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.", "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization", "previews": [], "headers": [], @@ -38530,7 +39824,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes.\nIf the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user", "previews": [], "headers": [], @@ -38583,7 +39877,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization", "previews": [], "headers": [], @@ -38649,7 +39943,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user", "previews": [], "headers": [], @@ -38715,7 +40009,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes.\nIf the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user", "previews": [], "headers": [], @@ -38781,7 +40075,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization", "previews": [], "headers": [], @@ -38860,7 +40154,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user", "previews": [], "headers": [], @@ -38939,7 +40233,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists package versions for a package owned by an organization.\n\nIf the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization", "previews": [], "headers": [], @@ -38985,7 +40279,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -38998,7 +40292,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -39063,7 +40357,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user", "previews": [], "headers": [], @@ -39096,7 +40390,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -39109,7 +40403,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -39174,7 +40468,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user", "previews": [], "headers": [], @@ -39207,7 +40501,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -39220,7 +40514,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -39274,7 +40568,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists package versions for a package owned by an organization.\n\nIf the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization", "previews": [], "headers": [], @@ -39320,7 +40614,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -39333,7 +40627,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -39387,7 +40681,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists package versions for a public package owned by a specified user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user", "previews": [], "headers": [], @@ -39461,7 +40755,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific package for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user", "previews": [], "headers": [], @@ -39515,7 +40809,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific package in an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization", "previews": [], "headers": [], @@ -39582,7 +40876,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific package metadata for a public package owned by a user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#get-a-package-for-a-user", "previews": [], "headers": [], @@ -39649,7 +40943,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific package version for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user", "previews": [], "headers": [], @@ -39716,7 +41010,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific package version in an organization.\n\nYou must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization", "previews": [], "headers": [], @@ -39796,7 +41090,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific package version for a public package owned by a specified user.\n\nAt this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user", "previews": [], "headers": [], @@ -39876,7 +41170,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope.", + "description": "Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user", "previews": [], "headers": [], @@ -39903,7 +41197,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope.", + "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization", "previews": [], "headers": [], @@ -39950,7 +41244,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope.", + "description": "Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user", "previews": [], "headers": [], @@ -39997,7 +41291,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#list-packages-for-the-authenticated-users-namespace", "previews": [], "headers": [], @@ -40030,7 +41324,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -40043,7 +41337,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -40082,7 +41376,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists packages in an organization readable by the user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#list-packages-for-an-organization", "previews": [], "headers": [], @@ -40128,7 +41422,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -40141,7 +41435,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -40186,7 +41480,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#list-packages-for-a-user", "previews": [], "headers": [], @@ -40232,7 +41526,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -40245,7 +41539,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -40290,7 +41584,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user", "previews": [], "headers": [], @@ -40356,7 +41650,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization", "previews": [], "headers": [], @@ -40435,7 +41729,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user", "previews": [], "headers": [], @@ -40514,7 +41808,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user", "previews": [], "headers": [], @@ -40580,7 +41874,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization", "previews": [], "headers": [], @@ -40659,7 +41953,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "documentationUrl": "https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user", "previews": [], "headers": [], @@ -41573,7 +42867,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -41586,7 +42880,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -41660,7 +42954,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -41673,7 +42967,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -41740,7 +43034,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -41753,7 +43047,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -41827,7 +43121,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -41840,7 +43134,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -41925,7 +43219,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -41938,7 +43232,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -42018,7 +43312,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -42031,7 +43325,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -42600,7 +43894,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", "documentationUrl": "https://docs.github.com/rest/pulls/pulls#create-a-pull-request", "previews": [], "headers": [], @@ -42764,7 +44058,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment", "previews": [], "headers": [], @@ -42858,7 +44152,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", + "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint 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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request", "previews": [], "headers": [], @@ -42969,7 +44263,7 @@ }, { "name": "comments[].position", - "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", + "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", "in": "BODY", "type": "integer", "required": false, @@ -43074,7 +44368,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request", "previews": [], "headers": [], @@ -43159,7 +44453,7 @@ }, { "name": "position", - "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", "in": "BODY", "type": "integer", "required": false, @@ -43277,7 +44571,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.", + "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request", "previews": [], "headers": [], @@ -43423,7 +44717,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.", + "description": "Dismisses a specified review on a pull request.\n\n**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection),\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request", "previews": [], "headers": [], @@ -43535,7 +44829,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", "documentationUrl": "https://docs.github.com/rest/pulls/pulls#get-a-pull-request", "previews": [], "headers": [], @@ -43606,7 +44900,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Retrieves a pull request review by its ID.", + "description": "Retrieves a pull request review by its ID.\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request", "previews": [], "headers": [], @@ -43687,7 +44981,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Provides details for a review comment.", + "description": "Provides details for a specified review comment.\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request", "previews": [], "headers": [], @@ -43755,7 +45049,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.\n- **`application/vnd.github.patch`**: For more information, see \"[git-format-patch](https://git-scm.com/docs/git-format-patch)\" in the Git documentation.", "documentationUrl": "https://docs.github.com/rest/pulls/pulls#list-pull-requests", "previews": [], "headers": [], @@ -43853,7 +45147,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -43866,7 +45160,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -43906,7 +45200,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List comments for a specific pull request review.", + "description": "Lists comments for a specific pull request review.\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review", "previews": [], "headers": [], @@ -43965,7 +45259,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -43978,7 +45272,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -44013,7 +45307,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint.", + "description": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits)\nendpoint.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", "documentationUrl": "https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request", "previews": [], "headers": [], @@ -44059,7 +45353,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -44072,7 +45366,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -44106,7 +45400,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.", + "description": "Lists the files in a specified pull request.\n\n**Note:** Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", "documentationUrl": "https://docs.github.com/rest/pulls/pulls#list-pull-requests-files", "previews": [], "headers": [], @@ -44152,7 +45446,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -44165,7 +45459,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -44273,7 +45567,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", + "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request", "previews": [], "headers": [], @@ -44358,7 +45652,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -44371,7 +45665,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -44405,7 +45699,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", + "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository", "previews": [], "headers": [], @@ -44477,7 +45771,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -44490,7 +45784,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -44524,7 +45818,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "The list of reviews returns in chronological order.", + "description": "Lists all reviews for a specified pull request. The list of reviews returns 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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request", "previews": [], "headers": [], @@ -44570,7 +45864,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -44583,7 +45877,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -44617,7 +45911,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "documentationUrl": "https://docs.github.com/rest/pulls/pulls#merge-a-pull-request", "previews": [], "headers": [], @@ -44956,7 +46250,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request).\"", + "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request", "previews": [], "headers": [], @@ -45069,7 +46363,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\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.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", "documentationUrl": "https://docs.github.com/rest/pulls/pulls#update-a-pull-request", "previews": [], "headers": [], @@ -45293,7 +46587,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Update the review summary comment with new text.", + "description": "Updates the contents of a specified review summary comment.\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request", "previews": [], "headers": [], @@ -45391,7 +46685,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Enables you to edit a review comment.", + "description": "Edits the content of a specified review comment.\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request", "previews": [], "headers": [], @@ -45471,7 +46765,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/overview/api-versions).\"\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/overview/api-versions).\"\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "documentationUrl": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user", "previews": [], "headers": [], @@ -46006,7 +47300,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", + "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment", "previews": [], "headers": [], @@ -46117,7 +47411,7 @@ "isDeprecated": true, "deprecationDate": "2020-02-26", "removalDate": "2021-02-21", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy", "previews": [], "headers": [], @@ -46206,7 +47500,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", + "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion", "previews": [], "headers": [], @@ -46304,7 +47598,7 @@ "isDeprecated": true, "deprecationDate": "2020-02-26", "removalDate": "2021-02-21", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy", "previews": [], "headers": [], @@ -46730,7 +48024,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction", "previews": [], "headers": [], @@ -46800,7 +48094,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction", "previews": [], "headers": [], @@ -46951,7 +48245,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -46964,7 +48258,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47067,7 +48361,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47080,7 +48374,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47184,7 +48478,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47197,7 +48491,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47300,7 +48594,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47313,7 +48607,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47407,7 +48701,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47420,7 +48714,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47455,7 +48749,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", + "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment", "previews": [], "headers": [], @@ -47536,7 +48830,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47549,7 +48843,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47583,7 +48877,7 @@ "isDeprecated": true, "deprecationDate": "2020-02-26", "removalDate": "2021-02-21", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy", "previews": [], "headers": [], @@ -47651,7 +48945,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47664,7 +48958,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47698,7 +48992,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", + "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion", "previews": [], "headers": [], @@ -47766,7 +49060,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47779,7 +49073,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47813,7 +49107,7 @@ "isDeprecated": true, "deprecationDate": "2020-02-26", "removalDate": "2021-02-21", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy", "previews": [], "headers": [], @@ -47868,7 +49162,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47881,7 +49175,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -47997,7 +49291,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions", "previews": [], "headers": [], @@ -48082,7 +49376,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "documentationUrl": "https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator", "previews": [], "headers": [], @@ -48421,6 +49715,70 @@ ], "renamed": null }, + { + "name": "Cancel a GitHub Pages deployment", + "scope": "repos", + "id": "cancelPagesDeployment", + "method": "POST", + "url": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Cancels a GitHub Pages deployment.\n\nThe authenticated user must have write permissions for the GitHub Pages site.", + "documentationUrl": "https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "pages_deployment_id", + "description": "The ID of the Pages deployment. You can also give the commit SHA of the deployment.", + "in": "PATH", + "type": null, + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 204, + "description": "A header with no content is returned.", + "examples": null + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "Check if automated security fixes are enabled for a repository", "scope": "repos", @@ -48485,7 +49843,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator", "previews": [], "headers": [], @@ -48784,7 +50142,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. You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\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 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. |", "documentationUrl": "https://docs.github.com/rest/commits/commits#compare-two-commits", "previews": [], "headers": [], @@ -48817,7 +50175,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -48830,7 +50188,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -48978,7 +50336,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/commits/comments#create-a-commit-comment", "previews": [], "headers": [], @@ -49388,7 +50746,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", + "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/deployments#create-a-deployment", "previews": [], "headers": [], @@ -49578,7 +50936,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Creates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy", "previews": [], "headers": [], @@ -49611,7 +50969,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -49687,14 +51045,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Enable a custom deployment protection rule for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).", + "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment", "previews": [], "headers": [], "parameters": [ { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -49767,7 +51125,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Users with `push` access can create deployment statuses for a given deployment.\n\nGitHub Apps require `read & write` access to \"Deployments\" and `read-only` access to \"Repo contents\" (for private repos). OAuth apps require the `repo_deployment` scope.", + "description": "Users with `push` access can create deployment statuses for a given deployment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/statuses#create-a-deployment-status", "previews": [], "headers": [], @@ -49938,7 +51296,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis endpoint requires write access to the repository by providing either:\n\n - Personal access tokens with `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", + "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event", "previews": [], "headers": [], @@ -50028,7 +51386,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", + "description": "Creates a new repository for the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", "documentationUrl": "https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user", "previews": [], "headers": [], @@ -50339,7 +51697,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"organization\":null,\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"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\"},\"language\":null,\"forks_count\":9,\"forks\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"open_issues\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"push\":false,\"admin\":false},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"web_commit_signoff_required\":false,\"subscribers_count\":42,\"network_count\":0,\"organization\":{\"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\":\"Organization\",\"site_admin\":false},\"parent\":{\"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,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"source\":{\"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,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}}" } ] }, @@ -50472,7 +51830,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", "documentationUrl": "https://docs.github.com/rest/repos/repos#create-an-organization-repository", "previews": [], "headers": [], @@ -50804,7 +52162,7 @@ }, { "name": "custom_properties", - "description": "The custom properties for the new respository. The keys are the custom property names, and the values are the corresponding custom property values.", + "description": "The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.", "in": "BODY", "type": "object", "required": false, @@ -50835,7 +52193,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"organization\":null,\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"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\"},\"language\":null,\"forks_count\":9,\"forks\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"open_issues\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"push\":false,\"admin\":false},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"web_commit_signoff_required\":false,\"subscribers_count\":42,\"network_count\":0,\"organization\":{\"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\":\"Organization\",\"site_admin\":false},\"parent\":{\"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,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"source\":{\"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,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}}" } ] }, @@ -50848,6 +52206,102 @@ ], "renamed": null }, + { + "name": "Create or update custom property values for a repository", + "scope": "repos", + "id": "createOrUpdateCustomPropertiesValues", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/properties/values", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Create new or update existing custom property values for a repository.\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties", + "description": "A list of custom property names and associated values to apply to the repositories.", + "in": "BODY", + "type": "object[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].property_name", + "description": "The name of the property", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].value", + "description": "The value assigned to the property", + "in": "BODY", + "type": null, + "required": true, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 204, + "description": "No Content when custom property values are successfully created or updated", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, { "name": "Create or update an environment", "scope": "repos", @@ -50857,7 +52311,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/environments#create-or-update-an-environment", "previews": [], "headers": [], @@ -50890,7 +52344,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -51033,7 +52487,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", + "description": "Creates a new file or replaces an existing file in a repository.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", "documentationUrl": "https://docs.github.com/rest/repos/contents#create-or-update-file-contents", "previews": [], "headers": [], @@ -51714,11 +53168,11 @@ "scope": "repos", "id": "createPagesDeployment", "method": "POST", - "url": "/repos/{owner}/{repo}/pages/deployment", + "url": "/repos/{owner}/{repo}/pages/deployments", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Create a GitHub Pages deployment for a repository.\n\nUsers must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint.", + "description": "Create a GitHub Pages deployment for a repository.\n\nThe authenticated user must have write permission to the repository.", "documentationUrl": "https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment", "previews": [], "headers": [], @@ -51749,12 +53203,25 @@ "alias": null, "deprecated": null }, + { + "name": "artifact_id", + "description": "The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required.", + "in": "BODY", + "type": "number", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "artifact_url", - "description": "The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository.", + "description": "The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required.", "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -51808,7 +53275,7 @@ "description": "Response", "examples": [ { - "data": "{\"status_url\":\"https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status\",\"page_url\":\"developer.github.com\"}" + "data": "{\"id\":\"4fd754f7e594640989b406850d0bc8f06a121251\",\"status_url\":\"https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status\",\"page_url\":\"developer.github.com\"}" } ] }, @@ -51832,7 +53299,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"\n\nTo use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.", + "description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site", "previews": [], "headers": [], @@ -51944,7 +53411,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "documentationUrl": "https://docs.github.com/rest/releases/releases#create-a-release", "previews": [], "headers": [], @@ -52688,7 +54155,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", "documentationUrl": "https://docs.github.com/rest/repos/repos#create-a-repository-using-a-template", "previews": [], "headers": [], @@ -52791,7 +54258,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"forks\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"open_issues\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_auto_merge\":false,\"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\"}}" + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"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\"},\"language\":null,\"forks_count\":9,\"forks\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"open_issues\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"push\":false,\"admin\":false},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"web_commit_signoff_required\":false,\"subscribers_count\":42,\"network_count\":0,\"organization\":{\"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\":\"Organization\",\"site_admin\":false},\"parent\":{\"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,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"source\":{\"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,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}}" } ] } @@ -52916,32 +54383,6 @@ "alias": null, "deprecated": null }, - { - "name": "config.token", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.digest", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "events", "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", @@ -53080,7 +54521,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.", + "description": "Deleting a repository requires admin access.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.\n\nOAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/repos/repos#delete-a-repository", "previews": [], "headers": [], @@ -53254,7 +54695,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "You must authenticate using an access token with the repo scope to use this endpoint.", + "description": "OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/environments#delete-an-environment", "previews": [], "headers": [], @@ -53287,7 +54728,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -53610,7 +55051,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status).\"", + "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/deployments#delete-a-deployment", "previews": [], "headers": [], @@ -53675,7 +55116,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Deletes a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy", "previews": [], "headers": [], @@ -53708,7 +55149,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -54042,7 +55483,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nTo use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.", + "description": "Deletes a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site", "previews": [], "headers": [], @@ -54495,14 +55936,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Disables a custom deployment protection rule for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)\".", + "description": "Disables a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment", "previews": [], "headers": [], "parameters": [ { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -55184,7 +56625,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"forks\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"open_issues\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"has_discussions\":false,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"push\":false,\"admin\":false},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"organization\":{\"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\":\"Organization\",\"site_admin\":false},\"parent\":{\"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,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"source\":{\"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,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1,\"security_and_analysis\":{\"advanced_security\":{\"status\":\"enabled\"},\"secret_scanning\":{\"status\":\"enabled\"},\"secret_scanning_push_protection\":{\"status\":\"disabled\"}}}}" + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"forks_count\":9,\"forks\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"open_issues\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"has_discussions\":false,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"push\":false,\"admin\":false},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"organization\":{\"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\":\"Organization\",\"site_admin\":false},\"parent\":{\"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,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"source\":{\"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\",\"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,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1,\"security_and_analysis\":{\"advanced_security\":{\"status\":\"enabled\"},\"secret_scanning\":{\"status\":\"enabled\"},\"secret_scanning_push_protection\":{\"status\":\"disabled\"}}}}" } ] }, @@ -55338,14 +56779,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).", + "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment", "previews": [], "headers": [], "parameters": [ { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -55405,7 +56846,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Lists the environments for a repository.\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.", "documentationUrl": "https://docs.github.com/rest/deployments/environments#list-environments", "previews": [], "headers": [], @@ -55438,7 +56879,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -55451,7 +56892,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -55582,7 +57023,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -55595,7 +57036,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -55628,7 +57069,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch", "previews": [], "headers": [], @@ -55947,7 +57388,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -55960,7 +57401,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -56062,7 +57503,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", + "description": "\nReturns a weekly aggregate of the number of additions and deletions pushed to a repository.\n\n**Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains\n10,000 or more commits, a 422 status code will be returned.\n", "documentationUrl": "https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity", "previews": [], "headers": [], @@ -56109,6 +57550,11 @@ "code": 204, "description": "A header with no content is returned.", "examples": null + }, + { + "code": 422, + "description": "Repository contains more than 10,000 commits", + "examples": null } ], "renamed": null @@ -56236,7 +57682,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -56249,7 +57695,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -56284,7 +57730,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n**Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nYou can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.\n\nTo return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on 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": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n**Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\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).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on 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#get-a-commit", "previews": [], "headers": [], @@ -56317,7 +57763,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -56330,7 +57776,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -56449,7 +57895,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", + "description": "Gets a specified commit comment.\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/commits/comments#get-a-commit-comment", "previews": [], "headers": [], @@ -56639,7 +58085,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/rest/overview/media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/rest/git/trees#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n Size limits:\nIf the requested file's size is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\n\n If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n If the content is a symlink: \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n If the content is a submodule:\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\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.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported.", "documentationUrl": "https://docs.github.com/rest/repos/contents#get-repository-content", "previews": [], "headers": [], @@ -56743,7 +58189,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits\n\n**Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.", "documentationUrl": "https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity", "previews": [], "headers": [], @@ -56807,7 +58253,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).", + "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule", "previews": [], "headers": [], @@ -56840,7 +58286,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -57079,7 +58525,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a deployment branch or tag policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a deployment branch or tag policy for an environment.\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.", "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy", "previews": [], "headers": [], @@ -57112,7 +58558,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -57240,7 +58686,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint. If the\nrepository is private, you must use an access token with the `repo` scope. GitHub\nApps must have the `actions:read` permission to use this endpoint.", + "description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\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.", "documentationUrl": "https://docs.github.com/rest/deployments/environments#get-an-environment", "previews": [], "headers": [], @@ -57273,7 +58719,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -57307,7 +58753,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets information about the single most recent build of a GitHub Pages site.\n\nA token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.", + "description": "Gets information about the single most recent build of a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/pages/pages#get-latest-pages-build", "previews": [], "headers": [], @@ -57543,7 +58989,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -57556,7 +59002,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -57668,7 +59114,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -57681,7 +59127,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -57717,7 +59163,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets information about a GitHub Pages site.\n\nA token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.", + "description": "Gets information about a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site", "previews": [], "headers": [], @@ -57772,7 +59218,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets information about a GitHub Pages build.\n\nA token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.", + "description": "Gets information about a GitHub Pages build.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/pages/pages#get-apiname-pages-build", "previews": [], "headers": [], @@ -57830,6 +59276,70 @@ ], "renamed": null }, + { + "name": "Get the status of a GitHub Pages deployment", + "scope": "repos", + "id": "getPagesDeployment", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the current status of a GitHub Pages deployment.\n\nThe authenticated user must have read permission for the GitHub Pages site.", + "documentationUrl": "https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "pages_deployment_id", + "description": "The ID of the Pages deployment. You can also give the commit SHA of the deployment.", + "in": "PATH", + "type": null, + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [{ "data": "{\"status\":\"succeed\"}" }] + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "Get a DNS health check for GitHub Pages", "scope": "repos", @@ -57839,7 +59349,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.\n\nThe first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.\n\nTo use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions.", + "description": "Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.\n\nThe first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages", "previews": [], "headers": [], @@ -58086,7 +59596,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML.", + "description": "Gets the preferred README for a repository.\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.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "documentationUrl": "https://docs.github.com/rest/repos/contents#get-a-repository-readme", "previews": [], "headers": [], @@ -58159,7 +59669,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML.", + "description": "Gets the README from a repository directory.\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.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "documentationUrl": "https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory", "previews": [], "headers": [], @@ -58245,7 +59755,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia).", + "description": "Gets a public release with the specified release ID.\n\n**Note:** This returns an `upload_url` key corresponding to the endpoint\nfor uploading release assets. This key is a hypermedia resource. For more information, see\n\"[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "documentationUrl": "https://docs.github.com/rest/releases/releases#get-a-release", "previews": [], "headers": [], @@ -58293,7 +59803,7 @@ "responses": [ { "code": 200, - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia).", + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "examples": [ { "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" @@ -58604,7 +60114,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -58617,7 +60127,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -58768,7 +60278,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -58781,7 +60291,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -59280,7 +60790,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use \"[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook).\"\n\nAccess tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission.", + "description": "Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use \"[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository", "previews": [], "headers": [], @@ -59480,7 +60990,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -59493,7 +61003,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -59506,7 +61016,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -59596,7 +61106,7 @@ "renamed": null }, { - "name": "List all autolinks of a repository", + "name": "Get all autolinks of a repository", "scope": "repos", "id": "listAutolinks", "method": "GET", @@ -59604,8 +61114,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This returns a list of autolinks configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.", - "documentationUrl": "https://docs.github.com/rest/repos/autolinks#list-all-autolinks-of-a-repository", + "description": "Gets all autolinks that are configured for a repository.\n\nInformation about autolinks are only available to repository administrators.", + "documentationUrl": "https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository", "previews": [], "headers": [], "parameters": [ @@ -59634,19 +61144,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -59717,7 +61214,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -59730,7 +61227,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -59837,7 +61334,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators", "previews": [], "headers": [], @@ -59896,7 +61393,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -59909,7 +61406,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -59944,7 +61441,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Use the `:commit_sha` to specify the commit that will have its comments listed.", + "description": "Lists the comments for a specified commit.\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/commits/comments#list-commit-comments", "previews": [], "headers": [], @@ -59990,7 +61487,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60003,7 +61500,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60037,7 +61534,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/).\n\nComments are ordered by ascending ID.", + "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository", "previews": [], "headers": [], @@ -60070,7 +61567,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60083,7 +61580,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60163,7 +61660,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60176,7 +61673,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60322,7 +61819,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60335,7 +61832,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60420,7 +61917,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60433,7 +61930,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60474,14 +61971,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)\".", + "description": "Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment", "previews": [], "headers": [], "parameters": [ { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -60520,7 +62017,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60533,7 +62030,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60600,7 +62097,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60613,7 +62110,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60647,7 +62144,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the deployment branch policies for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Lists the deployment branch policies for an environment.\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.", "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies", "previews": [], "headers": [], @@ -60680,7 +62177,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -60693,7 +62190,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60706,7 +62203,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60786,7 +62283,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60799,7 +62296,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60919,7 +62416,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -60932,7 +62429,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61038,7 +62535,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61051,7 +62548,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61182,7 +62679,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61195,7 +62692,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61229,7 +62726,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", + "description": "Lists public repositories for the specified user.", "documentationUrl": "https://docs.github.com/rest/repos/repos#list-repositories-for-a-user", "previews": [], "headers": [], @@ -61288,7 +62785,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61301,7 +62798,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61381,7 +62878,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61394,7 +62891,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61463,7 +62960,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61476,7 +62973,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61517,7 +63014,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61530,7 +63027,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61622,7 +63119,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists builts of a GitHub Pages site.\n\nA token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.", + "description": "Lists builts of a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/pages/pages#list-apiname-pages-builds", "previews": [], "headers": [], @@ -61655,7 +63152,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61668,7 +63165,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61795,7 +63292,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61808,7 +63305,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61888,7 +63385,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61901,7 +63398,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61968,7 +63465,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -61981,7 +63478,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -62101,7 +63598,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -62114,7 +63611,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -62148,7 +63645,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the teams that have access to the specified repository and that are also visible to the authenticated user.\n\nFor a public repository, a team is listed only if that team added the public repository explicitly.\n\nPersonal access tokens require the following scopes:\n* `public_repo` to call this endpoint on a public repository\n* `repo` to call this endpoint on a private repository (this scope also includes public repositories)\n\nThis endpoint is not compatible with fine-grained personal access tokens.", + "description": "Lists the teams that have access to the specified repository and that are also visible to the authenticated user.\n\nFor a public repository, a team is listed only if that team added the public repository explicitly.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository.", "documentationUrl": "https://docs.github.com/rest/repos/repos#list-repository-teams", "previews": [], "headers": [], @@ -62181,7 +63678,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -62194,7 +63691,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -62275,7 +63772,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -62375,7 +63872,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -62388,7 +63885,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -62757,7 +64254,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions", "previews": [], "headers": [], @@ -63220,7 +64717,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Renames a branch in a repository.\n\n**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)\".\n\nThe permissions required to use this endpoint depends on whether you are renaming the default branch.\n\nTo rename a non-default branch:\n\n* Users must have push access.\n* GitHub Apps must have the `contents:write` repository permission.\n\nTo rename the default branch:\n\n* Users must have admin or owner permissions.\n* GitHub Apps must have the `administration:write` repository permission.", + "description": "Renames a branch in a repository.\n\n**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", "documentationUrl": "https://docs.github.com/rest/branches/branches#rename-a-branch", "previews": [], "headers": [], @@ -63499,7 +64996,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions", "previews": [], "headers": [], @@ -63896,7 +65393,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).\nYou must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account.", + "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).", "documentationUrl": "https://docs.github.com/rest/repos/repos#transfer-a-repository", "previews": [], "headers": [], @@ -64931,7 +66428,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", + "description": "Updates the contents of a specified commit comment.\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-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "documentationUrl": "https://docs.github.com/rest/commits/comments#update-a-commit-comment", "previews": [], "headers": [], @@ -65012,7 +66509,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Updates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy", "previews": [], "headers": [], @@ -65045,7 +66542,7 @@ }, { "name": "environment_name", - "description": "The name of the environment.", + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "in": "PATH", "type": "string", "required": true, @@ -65105,7 +66602,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates information for a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nTo use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.", + "description": "Updates information for a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site", "previews": [], "headers": [], @@ -67098,7 +68595,7 @@ }, { "name": "config", - "description": "Key/value pairs to provide settings for this webhook.", + "description": "Configuration object of the webhook", "in": "BODY", "type": "object", "required": false, @@ -67114,7 +68611,7 @@ "description": "The URL to which the payloads will be delivered.", "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -67161,32 +68658,6 @@ "alias": null, "deprecated": null }, - { - "name": "config.address", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.room", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "events", "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", @@ -67268,7 +68739,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use \"[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook).\"\n\nAccess tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission.", + "description": "Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use \"[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository", "previews": [], "headers": [], @@ -67387,7 +68858,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", + "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", "documentationUrl": "https://docs.github.com/rest/releases/assets#upload-a-release-asset", "previews": [], "headers": [], @@ -67511,7 +68982,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "documentationUrl": "https://docs.github.com/rest/search/search#search-code", "previews": [], "headers": [], @@ -67557,7 +69028,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -67570,7 +69041,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -67612,7 +69083,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", + "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", "documentationUrl": "https://docs.github.com/rest/search/search#search-commits", "previews": [], "headers": [], @@ -67658,7 +69129,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -67671,7 +69142,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -67706,7 +69177,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", "documentationUrl": "https://docs.github.com/rest/search/search#search-issues-and-pull-requests", "previews": [], "headers": [], @@ -67764,7 +69235,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -67777,7 +69248,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -67819,7 +69290,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", "documentationUrl": "https://docs.github.com/rest/search/search#search-labels", "previews": [], "headers": [], @@ -67878,7 +69349,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -67891,7 +69362,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -67933,7 +69404,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", "documentationUrl": "https://docs.github.com/rest/search/search#search-repositories", "previews": [], "headers": [], @@ -67979,7 +69450,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -67992,7 +69463,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -68033,7 +69504,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See \"[Searching topics](https://docs.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", + "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", "documentationUrl": "https://docs.github.com/rest/search/search#search-topics", "previews": [], "headers": [], @@ -68053,7 +69524,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -68066,7 +69537,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -68101,7 +69572,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search).\"", + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search).\"", "documentationUrl": "https://docs.github.com/rest/search/search#search-users", "previews": [], "headers": [], @@ -68147,7 +69618,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -68160,7 +69631,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -68201,7 +69672,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a single secret scanning alert detected in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "description": "Gets a single secret scanning alert detected in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "documentationUrl": "https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert", "previews": [], "headers": [], @@ -68275,7 +69746,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).", + "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\n\nAlerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\n\nThe authenticated user must be a member of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise", "previews": [], "headers": [], @@ -68360,7 +69831,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -68373,7 +69844,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -68386,7 +69857,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -68435,7 +69906,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "documentationUrl": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization", "previews": [], "headers": [], @@ -68520,7 +69991,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -68533,7 +70004,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -68608,7 +70079,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists secret scanning alerts for an eligible repository, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "description": "Lists secret scanning alerts for an eligible repository, from newest to oldest.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "documentationUrl": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository", "previews": [], "headers": [], @@ -68706,7 +70177,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -68719,7 +70190,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -68798,7 +70269,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all locations for a given secret scanning alert for an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "description": "Lists all locations for a given secret scanning alert for an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "documentationUrl": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert", "previews": [], "headers": [], @@ -68844,7 +70315,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -68857,7 +70328,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -68875,7 +70346,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\"}}]" + "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\"}}]" } ] }, @@ -68897,7 +70368,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates the status of a secret scanning alert in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "documentationUrl": "https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert", "previews": [], "headers": [], @@ -69010,6 +70481,82 @@ ], "renamed": null }, + { + "name": "Create a temporary private fork", + "scope": "securityAdvisories", + "id": "createFork", + "method": "POST", + "url": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.\n\n**Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.", + "documentationUrl": "https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "ghsa_id", + "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 202, + "description": "Response", + "examples": [ + { + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"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\"},\"language\":null,\"forks_count\":9,\"forks\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"open_issues\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"push\":false,\"admin\":false},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"web_commit_signoff_required\":false,\"subscribers_count\":42,\"network_count\":0,\"organization\":{\"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\":\"Organization\",\"site_admin\":false},\"parent\":{\"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,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"source\":{\"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,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}}" + } + ] + }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, { "name": "Privately report a security vulnerability", "scope": "securityAdvisories", @@ -69219,6 +70766,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "start_private_fork", + "description": "Whether to create a temporary private fork of the repository to collaborate on a fix.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -69250,7 +70810,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a new repository security advisory.\nYou must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.\n\nIn order to create a draft repository security advisory, you must be a security manager or administrator of that repository.", + "description": "Creates a new repository security advisory.\n\nIn order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory", "previews": [], "headers": [], @@ -69513,6 +71073,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "start_private_fork", + "description": "Whether to create a temporary private fork of the repository to collaborate on a fix.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -69544,7 +71117,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional).\"\n\nYou may request a CVE for public repositories, but cannot do so for private repositories.\n\nYou must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.\n\nIn order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository.", + "description": "If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional).\"\n\nYou may request a CVE for public repositories, but cannot do so for private repositories.\n\nIn order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory", "previews": [], "headers": [], @@ -69658,7 +71231,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\nYou can access any published security advisory on a public repository.\nYou must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission\nin order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to.\n\nYou can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a\ncollaborator on the security advisory.", + "description": "Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\n\nAnyone can access any published security advisory on a public repository.\n\nThe authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a\ncollaborator on the security advisory.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.", "documentationUrl": "https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory", "previews": [], "headers": [], @@ -69890,7 +71463,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -69903,7 +71476,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -69929,7 +71502,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -69982,7 +71555,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists repository security advisories for an organization.\n\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission.", + "description": "Lists repository security advisories for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization", "previews": [], "headers": [], @@ -70028,7 +71601,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -70041,7 +71614,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -70054,7 +71627,7 @@ }, { "name": "per_page", - "description": "The number of advisories to return per page.", + "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -70104,7 +71677,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists security advisories in a repository.\nYou must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission\nin order to get published security advisories in a private repository, or any unpublished security advisories that you have access to.\n\nYou can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory.", + "description": "Lists security advisories in a repository.\n\nThe authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.", "documentationUrl": "https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories", "previews": [], "headers": [], @@ -70163,7 +71736,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -70176,7 +71749,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "string", "required": false, @@ -70189,7 +71762,7 @@ }, { "name": "per_page", - "description": "Number of advisories to return per page.", + "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -70239,7 +71812,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\nYou must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.\n\nIn order to update any security advisory, you must be a security manager or administrator of that repository,\nor a collaborator on the repository security advisory.", + "description": "Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\n\nIn order to update any security advisory, the authenticated user must be a security manager or administrator of that repository,\nor a collaborator on the repository security advisory.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory", "previews": [], "headers": [], @@ -70595,7 +72168,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", "documentationUrl": "https://docs.github.com/rest/teams/members#add-team-member-legacy", "previews": [], "headers": [], @@ -70866,7 +72439,7 @@ }, { "name": "permission", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", "in": "BODY", "type": "string", "required": false, @@ -70934,7 +72507,7 @@ }, { "name": "permission", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", "in": "BODY", "type": "string", "required": false, @@ -70975,7 +72548,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "documentationUrl": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions", "previews": [], "headers": [], @@ -71058,7 +72631,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", "documentationUrl": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy", "previews": [], "headers": [], @@ -71267,7 +72840,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "documentationUrl": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository", "previews": [], "headers": [], @@ -71585,7 +73158,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment", "previews": [], "headers": [], @@ -71665,7 +73238,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy", "previews": [], "headers": [], @@ -71732,7 +73305,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussions#create-a-discussion", "previews": [], "headers": [], @@ -71825,7 +73398,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy", "previews": [], "headers": [], @@ -71905,7 +73478,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", + "description": "Deletes a comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment", "previews": [], "headers": [], @@ -71975,7 +73548,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy", "previews": [], "headers": [], @@ -72032,7 +73605,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", + "description": "Delete a discussion from a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussions#delete-a-discussion", "previews": [], "headers": [], @@ -72089,7 +73662,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy", "previews": [], "headers": [], @@ -72271,7 +73844,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", + "description": "Get a specific comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment", "previews": [], "headers": [], @@ -72351,7 +73924,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy", "previews": [], "headers": [], @@ -72418,7 +73991,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", + "description": "Get a specific discussion on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussions#get-a-discussion", "previews": [], "headers": [], @@ -72485,7 +74058,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy", "previews": [], "headers": [], @@ -72779,7 +74352,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -72792,7 +74365,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -72860,7 +74433,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -72873,7 +74446,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -72927,7 +74500,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -72940,7 +74513,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -72981,7 +74554,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "description": "List all comments on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments", "previews": [], "headers": [], @@ -73040,7 +74613,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73053,7 +74626,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73087,7 +74660,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy", "previews": [], "headers": [], @@ -73133,7 +74706,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73146,7 +74719,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73180,7 +74753,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.", + "description": "List all discussions on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussions#list-discussions", "previews": [], "headers": [], @@ -73226,7 +74799,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73239,7 +74812,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73286,7 +74859,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy", "previews": [], "headers": [], @@ -73319,7 +74892,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73332,7 +74905,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73366,14 +74939,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token.", + "description": "List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.", "documentationUrl": "https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73386,7 +74959,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73469,7 +75042,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73482,7 +75055,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73549,7 +75122,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73562,7 +75135,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73630,7 +75203,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73643,7 +75216,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73697,7 +75270,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73710,7 +75283,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73777,7 +75350,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73790,7 +75363,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73844,7 +75417,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73857,7 +75430,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73925,7 +75498,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73938,7 +75511,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -73992,7 +75565,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -74005,7 +75578,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -74442,7 +76015,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", + "description": "Edits the body text of a discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment", "previews": [], "headers": [], @@ -74535,7 +76108,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy", "previews": [], "headers": [], @@ -74615,7 +76188,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussions#update-a-discussion", "previews": [], "headers": [], @@ -74708,7 +76281,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy", "previews": [], "headers": [], @@ -75071,7 +76644,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This endpoint is accessible with the `user` scope.", + "description": "OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user", "previews": [], "headers": [], @@ -75130,7 +76703,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This endpoint is accessible with the `user` scope.", + "description": "OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user", "previews": [], "headers": [], @@ -75184,7 +76757,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope.", + "description": "Add one or more social accounts to the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user", "previews": [], "headers": [], @@ -75437,7 +77010,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "Adds a GPG key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -75509,7 +77082,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "Adds a GPG key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -75576,7 +77149,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "Adds a public SSH key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -75654,7 +77227,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "Adds a public SSH key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -75721,7 +77294,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "description": "Creates an SSH signing key for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -75788,7 +77361,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This endpoint is accessible with the `user` scope.", + "description": "OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user", "previews": [], "headers": [], @@ -75839,7 +77412,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This endpoint is accessible with the `user` scope.", + "description": "OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user", "previews": [], "headers": [], @@ -75885,7 +77458,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "Removes a GPG key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -75936,7 +77509,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "Removes a GPG key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -75982,7 +77555,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "Removes a public SSH key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -76034,7 +77607,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "Removes a public SSH key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -76075,7 +77648,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope.", + "description": "Deletes one or more social accounts from the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user", "previews": [], "headers": [], @@ -76121,7 +77694,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "description": "Deletes an SSH signing key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -76162,7 +77735,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nFollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/followers#follow-a-user", "previews": [], "headers": [], @@ -76203,7 +77776,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information.\n\nIf the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information.", + "description": "OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information.", "documentationUrl": "https://docs.github.com/rest/users/users#get-the-authenticated-user", "previews": [], "headers": [], @@ -76240,7 +77813,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Provides publicly available information about someone with a GitHub account.\n\nGitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)\" for details about authentication. For an example response, see 'Response with GitHub plan information' below\"\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/rest/users/emails)\".", + "description": "Provides publicly available information about someone with a GitHub account.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/rest/users/emails)\".", "documentationUrl": "https://docs.github.com/rest/users/users#get-a-user", "previews": [], "headers": [], @@ -76285,7 +77858,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. 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```", + "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.", "documentationUrl": "https://docs.github.com/rest/users/users#get-contextual-information-for-a-user", "previews": [], "headers": [], @@ -76358,7 +77931,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "View extended details for a single GPG key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -76412,7 +77985,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "View extended details for a single GPG key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -76461,7 +78034,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "View extended details for a single public SSH key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -76518,7 +78091,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "View extended details for a single public SSH key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -76567,7 +78140,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "description": "Gets extended details for an SSH signing key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user", "previews": [], "headers": [], @@ -76636,7 +78209,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -76678,7 +78251,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -76691,7 +78264,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -76745,7 +78318,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -76758,7 +78331,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -76800,14 +78373,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.", + "description": "Lists all of your email addresses, and specifies which one is visible\nto the public.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -76820,7 +78393,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -76867,14 +78440,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.", + "description": "Lists all of your email addresses, and specifies which one is visible\nto the public.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -76887,7 +78460,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -76936,7 +78509,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -76949,7 +78522,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77002,7 +78575,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77015,7 +78588,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77063,7 +78636,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77076,7 +78649,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77137,7 +78710,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77150,7 +78723,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77204,7 +78777,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77217,7 +78790,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77251,14 +78824,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "Lists the current user's GPG keys.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77271,7 +78844,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77318,14 +78891,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "Lists the current user's GPG keys.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77338,7 +78911,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77400,7 +78973,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77413,7 +78986,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77447,14 +79020,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.", + "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77467,7 +79040,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77517,14 +79090,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.", + "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77537,7 +79110,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77599,7 +79172,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77612,7 +79185,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77642,14 +79215,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "Lists the public SSH keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77662,7 +79235,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77712,14 +79285,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "Lists the public SSH keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77732,7 +79305,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77781,7 +79354,7 @@ "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77794,7 +79367,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77856,7 +79429,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77869,7 +79442,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77903,14 +79476,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "description": "Lists the SSH signing keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77923,7 +79496,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77985,7 +79558,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -77998,7 +79571,7 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "QUERY", "type": "integer", "required": false, @@ -78192,7 +79765,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.", + "description": "OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/followers#unfollow-a-user", "previews": [], "headers": [], diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts index b5d98896b..f0c12b031 100644 --- a/src/generated/endpoints.ts +++ b/src/generated/endpoints.ts @@ -344,6 +344,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { listWatchersForRepo: ["GET /repos/{owner}/{repo}/subscribers"], markNotificationsAsRead: ["PUT /notifications"], markRepoNotificationsAsRead: ["PUT /repos/{owner}/{repo}/notifications"], + markThreadAsDone: ["DELETE /notifications/threads/{thread_id}"], markThreadAsRead: ["PATCH /notifications/threads/{thread_id}"], setRepoSubscription: ["PUT /repos/{owner}/{repo}/subscription"], setThreadSubscription: [ @@ -620,10 +621,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = { updateForAuthenticatedUser: ["PATCH /user/codespaces/{codespace_name}"], }, copilot: { - addCopilotForBusinessSeatsForTeams: [ + addCopilotSeatsForTeams: [ "POST /orgs/{org}/copilot/billing/selected_teams", ], - addCopilotForBusinessSeatsForUsers: [ + addCopilotSeatsForUsers: [ "POST /orgs/{org}/copilot/billing/selected_users", ], cancelCopilotSeatAssignmentForTeams: [ @@ -948,6 +949,12 @@ const Endpoints: EndpointsDefaultsAndDecorations = { addSecurityManagerTeam: [ "PUT /orgs/{org}/security-managers/teams/{team_slug}", ], + assignTeamToOrgRole: [ + "PUT /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}", + ], + assignUserToOrgRole: [ + "PUT /orgs/{org}/organization-roles/users/{username}/{role_id}", + ], blockUser: ["PUT /orgs/{org}/blocks/{username}"], cancelInvitation: ["DELETE /orgs/{org}/invitations/{invitation_id}"], checkBlockedUser: ["GET /orgs/{org}/blocks/{username}"], @@ -956,6 +963,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { convertMemberToOutsideCollaborator: [ "PUT /orgs/{org}/outside_collaborators/{username}", ], + createCustomOrganizationRole: ["POST /orgs/{org}/organization-roles"], createInvitation: ["POST /orgs/{org}/invitations"], createOrUpdateCustomProperties: ["PATCH /orgs/{org}/properties/schema"], createOrUpdateCustomPropertiesValuesForRepos: [ @@ -966,6 +974,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], createWebhook: ["POST /orgs/{org}/hooks"], delete: ["DELETE /orgs/{org}"], + deleteCustomOrganizationRole: [ + "DELETE /orgs/{org}/organization-roles/{role_id}", + ], deleteWebhook: ["DELETE /orgs/{org}/hooks/{hook_id}"], enableOrDisableSecurityProductOnAllOrgRepos: [ "POST /orgs/{org}/{security_product}/{enablement}", @@ -977,6 +988,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], getMembershipForAuthenticatedUser: ["GET /user/memberships/orgs/{org}"], getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"], + getOrgRole: ["GET /orgs/{org}/organization-roles/{role_id}"], getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"], getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"], getWebhookDelivery: [ @@ -992,6 +1004,12 @@ const Endpoints: EndpointsDefaultsAndDecorations = { listInvitationTeams: ["GET /orgs/{org}/invitations/{invitation_id}/teams"], listMembers: ["GET /orgs/{org}/members"], listMembershipsForAuthenticatedUser: ["GET /user/memberships/orgs"], + listOrgRoleTeams: ["GET /orgs/{org}/organization-roles/{role_id}/teams"], + listOrgRoleUsers: ["GET /orgs/{org}/organization-roles/{role_id}/users"], + listOrgRoles: ["GET /orgs/{org}/organization-roles"], + listOrganizationFineGrainedPermissions: [ + "GET /orgs/{org}/organization-fine-grained-permissions", + ], listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], listPatGrantRepositories: [ "GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories", @@ -1006,6 +1024,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { listSecurityManagerTeams: ["GET /orgs/{org}/security-managers"], listWebhookDeliveries: ["GET /orgs/{org}/hooks/{hook_id}/deliveries"], listWebhooks: ["GET /orgs/{org}/hooks"], + patchCustomOrganizationRole: [ + "PATCH /orgs/{org}/organization-roles/{role_id}", + ], pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"], redeliverWebhookDelivery: [ "POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", @@ -1030,6 +1051,18 @@ const Endpoints: EndpointsDefaultsAndDecorations = { reviewPatGrantRequestsInBulk: [ "POST /orgs/{org}/personal-access-token-requests", ], + revokeAllOrgRolesTeam: [ + "DELETE /orgs/{org}/organization-roles/teams/{team_slug}", + ], + revokeAllOrgRolesUser: [ + "DELETE /orgs/{org}/organization-roles/users/{username}", + ], + revokeOrgRoleTeam: [ + "DELETE /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}", + ], + revokeOrgRoleUser: [ + "DELETE /orgs/{org}/organization-roles/users/{username}/{role_id}", + ], setMembershipForUser: ["PUT /orgs/{org}/memberships/{username}"], setPublicMembershipForAuthenticatedUser: [ "PUT /orgs/{org}/public_members/{username}", @@ -1320,6 +1353,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { {}, { mapToData: "users" }, ], + cancelPagesDeployment: [ + "POST /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel", + ], checkAutomatedSecurityFixes: [ "GET /repos/{owner}/{repo}/automated-security-fixes", ], @@ -1355,12 +1391,15 @@ const Endpoints: EndpointsDefaultsAndDecorations = { createForAuthenticatedUser: ["POST /user/repos"], createFork: ["POST /repos/{owner}/{repo}/forks"], createInOrg: ["POST /orgs/{org}/repos"], + createOrUpdateCustomPropertiesValues: [ + "PATCH /repos/{owner}/{repo}/properties/values", + ], createOrUpdateEnvironment: [ "PUT /repos/{owner}/{repo}/environments/{environment_name}", ], createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"], createOrgRuleset: ["POST /orgs/{org}/rulesets"], - createPagesDeployment: ["POST /repos/{owner}/{repo}/pages/deployment"], + createPagesDeployment: ["POST /repos/{owner}/{repo}/pages/deployments"], createPagesSite: ["POST /repos/{owner}/{repo}/pages"], createRelease: ["POST /repos/{owner}/{repo}/releases"], createRepoRuleset: ["POST /repos/{owner}/{repo}/rulesets"], @@ -1513,6 +1552,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { getOrgRulesets: ["GET /orgs/{org}/rulesets"], getPages: ["GET /repos/{owner}/{repo}/pages"], getPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/{build_id}"], + getPagesDeployment: [ + "GET /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}", + ], getPagesHealthCheck: ["GET /repos/{owner}/{repo}/pages/health"], getParticipationStats: ["GET /repos/{owner}/{repo}/stats/participation"], getPullRequestReviewProtection: [ @@ -1723,6 +1765,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], }, securityAdvisories: { + createFork: [ + "POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks", + ], createPrivateVulnerabilityReport: [ "POST /repos/{owner}/{repo}/security-advisories/reports", ], diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts index 1de25357c..ab2da478a 100644 --- a/src/generated/method-types.ts +++ b/src/generated/method-types.ts @@ -4,12 +4,11 @@ import type { RestEndpointMethodTypes } from "./parameters-and-response-types.js export type RestEndpointMethods = { actions: { /** - * Add custom labels to a self-hosted runner configured in an organization. + * Adds custom labels to a self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ addCustomLabelsToSelfHostedRunnerForOrg: { ( @@ -21,11 +20,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Add custom labels to a self-hosted runner configured in a repository. + * Adds custom labels to a self-hosted runner configured in a repository. + * + * Authenticated users must have admin access to the organization to use this endpoint. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ addCustomLabelsToSelfHostedRunnerForRepo: { ( @@ -38,13 +37,12 @@ export type RestEndpointMethods = { }; /** * Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or + * repository access is set to `selected`. For more information about setting the visibility, see [Create or * update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ addSelectedRepoToOrgSecret: { ( @@ -59,10 +57,9 @@ export type RestEndpointMethods = { * Adds a repository to an organization variable that is available to selected repositories. * Organization variables that are available to selected repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ addSelectedRepoToOrgVariable: { ( @@ -76,7 +73,7 @@ export type RestEndpointMethods = { /** * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * - * 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 tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ approveWorkflowRun: { ( @@ -90,8 +87,7 @@ export type RestEndpointMethods = { /** * Cancels a workflow run using its `id`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ cancelWorkflowRun: { ( @@ -105,9 +101,9 @@ export type RestEndpointMethods = { /** * Create an environment variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createEnvironmentVariable: { ( @@ -122,9 +118,9 @@ export type RestEndpointMethods = { * Creates or updates an environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createOrUpdateEnvironmentSecret: { ( @@ -225,9 +221,9 @@ export type RestEndpointMethods = { * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createOrUpdateRepoSecret: { ( @@ -241,10 +237,9 @@ export type RestEndpointMethods = { /** * Creates an organization variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createOrgVariable: { ( @@ -258,18 +253,15 @@ export type RestEndpointMethods = { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using registration token: - * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * * ``` * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` + * + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createRegistrationTokenForOrg: { ( @@ -281,19 +273,17 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Returns a token that you can pass to the `config` script. The token - * expires after one hour. + * Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * Example using registration token: + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided - * by this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createRegistrationTokenForRepo: { ( @@ -307,19 +297,15 @@ export type RestEndpointMethods = { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using remove token: - * - * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this - * endpoint. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * * ``` * ./config.sh remove --token TOKEN * ``` + * + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createRemoveTokenForOrg: { ( @@ -331,19 +317,17 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Returns a token that you can pass to remove a self-hosted runner from - * a repository. The token expires after one hour. + * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * Example using remove token: + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * To remove your self-hosted runner from a repository, replace TOKEN with - * the remove token provided by this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * ```config.sh remove --token TOKEN``` + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createRemoveTokenForRepo: { ( @@ -357,9 +341,9 @@ export type RestEndpointMethods = { /** * Creates a repository variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createRepoVariable: { ( @@ -375,7 +359,7 @@ export type RestEndpointMethods = { * * You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createWorkflowDispatch: { ( @@ -389,9 +373,7 @@ export type RestEndpointMethods = { /** * Deletes a GitHub Actions cache for a repository, using a cache ID. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteActionsCacheById: { ( @@ -405,9 +387,7 @@ export type RestEndpointMethods = { /** * Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. * - * 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 tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteActionsCacheByKey: { ( @@ -419,7 +399,8 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * Deletes an artifact for a workflow run. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteArtifact: { ( @@ -433,9 +414,9 @@ export type RestEndpointMethods = { /** * Deletes a secret in an environment using the secret name. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteEnvironmentSecret: { ( @@ -449,9 +430,9 @@ export type RestEndpointMethods = { /** * Deletes an environment variable using the variable name. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteEnvironmentVariable: { ( @@ -465,10 +446,9 @@ export type RestEndpointMethods = { /** * Deletes a secret in an organization using the secret name. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteOrgSecret: { ( @@ -482,10 +462,9 @@ export type RestEndpointMethods = { /** * Deletes an organization variable using the variable name. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteOrgVariable: { ( @@ -499,9 +478,9 @@ export type RestEndpointMethods = { /** * Deletes a secret in a repository using the secret name. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteRepoSecret: { ( @@ -515,9 +494,9 @@ export type RestEndpointMethods = { /** * Deletes a repository variable using the variable name. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteRepoVariable: { ( @@ -531,10 +510,9 @@ export type RestEndpointMethods = { /** * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteSelfHostedRunnerFromOrg: { ( @@ -548,9 +526,9 @@ export type RestEndpointMethods = { /** * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteSelfHostedRunnerFromRepo: { ( @@ -562,9 +540,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is - * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use - * this endpoint. + * Deletes a specific workflow run. + * + * Anyone with write access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteWorkflowRun: { ( @@ -576,7 +556,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * Deletes all logs for a workflow run. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteWorkflowRunLogs: { ( @@ -590,7 +572,7 @@ export type RestEndpointMethods = { /** * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ disableSelectedRepositoryGithubActionsOrganization: { ( @@ -604,7 +586,7 @@ export type RestEndpointMethods = { /** * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * - * 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 tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ disableWorkflow: { ( @@ -619,8 +601,7 @@ export type RestEndpointMethods = { * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ downloadArtifact: { ( @@ -633,9 +614,11 @@ export type RestEndpointMethods = { }; /** * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look - * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can - * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must - * have the `actions:read` permission to use this endpoint. + * for `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ downloadJobLogsForWorkflowRun: { ( @@ -648,9 +631,11 @@ export type RestEndpointMethods = { }; /** * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to - * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * 1 minute. Look for `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ downloadWorkflowRunAttemptLogs: { ( @@ -663,9 +648,11 @@ export type RestEndpointMethods = { }; /** * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use - * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have - * the `actions:read` permission to use this endpoint. + * `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ downloadWorkflowRunLogs: { ( @@ -679,7 +666,7 @@ export type RestEndpointMethods = { /** * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ enableSelectedRepositoryGithubActionsOrganization: { ( @@ -693,7 +680,7 @@ export type RestEndpointMethods = { /** * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * - * 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 tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ enableWorkflow: { ( @@ -708,8 +695,7 @@ export type RestEndpointMethods = { * Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ forceCancelWorkflowRun: { ( @@ -723,10 +709,9 @@ export type RestEndpointMethods = { /** * Generates a configuration that can be passed to the runner application at startup. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * The authenticated user must have admin access to the organization. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ generateRunnerJitconfigForOrg: { ( @@ -740,9 +725,9 @@ export type RestEndpointMethods = { /** * Generates a configuration that can be passed to the runner application at startup. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * The authenticated user must have admin access to the repository. + * + * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. */ generateRunnerJitconfigForRepo: { ( @@ -755,8 +740,8 @@ export type RestEndpointMethods = { }; /** * Lists the GitHub Actions caches for a repository. - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getActionsCacheList: { ( @@ -770,7 +755,10 @@ export type RestEndpointMethods = { /** * Gets GitHub Actions cache usage for a repository. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getActionsCacheUsage: { ( @@ -784,7 +772,8 @@ export type RestEndpointMethods = { /** * Lists repositories and their GitHub Actions cache usage for an organization. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ getActionsCacheUsageByRepoForOrg: { ( @@ -798,7 +787,8 @@ export type RestEndpointMethods = { /** * Gets the total GitHub Actions cache usage for an organization. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ getActionsCacheUsageForOrg: { ( @@ -810,9 +800,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + * Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ getAllowedActionsOrganization: { ( @@ -826,7 +816,7 @@ export type RestEndpointMethods = { /** * Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getAllowedActionsRepository: { ( @@ -838,7 +828,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Gets a specific artifact for a workflow run. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getArtifact: { ( @@ -852,9 +846,8 @@ export type RestEndpointMethods = { * secrets. You need to encrypt a secret before you can create or update secrets. * * Anyone with read access to the repository can use this endpoint. - * If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getEnvironmentPublicKey: { ( @@ -868,9 +861,9 @@ export type RestEndpointMethods = { /** * Gets a single environment secret without revealing its encrypted value. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getEnvironmentSecret: { ( @@ -884,9 +877,9 @@ export type RestEndpointMethods = { /** * Gets a specific variable in an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getEnvironmentVariable: { ( @@ -902,7 +895,7 @@ export type RestEndpointMethods = { * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ getGithubActionsDefaultWorkflowPermissionsOrganization: { ( @@ -918,7 +911,7 @@ export type RestEndpointMethods = { * as well as if GitHub Actions can submit approving pull request reviews. * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getGithubActionsDefaultWorkflowPermissionsRepository: { ( @@ -932,7 +925,7 @@ export type RestEndpointMethods = { /** * Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ getGithubActionsPermissionsOrganization: { ( @@ -946,7 +939,7 @@ export type RestEndpointMethods = { /** * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getGithubActionsPermissionsRepository: { ( @@ -958,7 +951,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Gets a specific job in a workflow run. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getJobForWorkflowRun: { ( @@ -973,10 +970,9 @@ export type RestEndpointMethods = { * Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getOrgPublicKey: { ( @@ -990,10 +986,9 @@ export type RestEndpointMethods = { /** * Gets a single organization secret without revealing its encrypted value. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getOrgSecret: { ( @@ -1007,10 +1002,9 @@ export type RestEndpointMethods = { /** * Gets a specific variable in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getOrgVariable: { ( @@ -1024,7 +1018,9 @@ export type RestEndpointMethods = { /** * Get all deployment environments for a workflow run that are waiting for protection rules to pass. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getPendingDeploymentsForRun: { ( @@ -1038,7 +1034,7 @@ export type RestEndpointMethods = { /** * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. * @deprecated octokit.rest.actions.getRepoPermissions() has been renamed to octokit.rest.actions.getGithubActionsPermissionsRepository() (2020-11-10) */ getRepoPermissions: { @@ -1055,9 +1051,8 @@ export type RestEndpointMethods = { * encrypt a secret before you can create or update secrets. * * Anyone with read access to the repository can use this endpoint. - * If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getRepoPublicKey: { ( @@ -1071,9 +1066,9 @@ export type RestEndpointMethods = { /** * Gets a single repository secret without revealing its encrypted value. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getRepoSecret: { ( @@ -1087,9 +1082,9 @@ export type RestEndpointMethods = { /** * Gets a specific variable in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getRepoVariable: { ( @@ -1101,7 +1096,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ getReviewsForRun: { ( @@ -1115,10 +1112,9 @@ export type RestEndpointMethods = { /** * Gets a specific self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ getSelfHostedRunnerForOrg: { ( @@ -1132,9 +1128,9 @@ export type RestEndpointMethods = { /** * Gets a specific self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getSelfHostedRunnerForRepo: { ( @@ -1146,7 +1142,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Gets a specific workflow. You can replace `workflow_id` with the workflow + * file name. For example, you could use `main.yaml`. + * + * Anyone with read access to the repository can use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ getWorkflow: { ( @@ -1160,8 +1161,7 @@ export type RestEndpointMethods = { * This endpoint only applies to private repositories. * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - * repository `administration` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getWorkflowAccessToRepository: { ( @@ -1173,7 +1173,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Gets a specific workflow run. + * + * 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. */ getWorkflowRun: { ( @@ -1185,10 +1189,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a specific workflow run attempt. Anyone with read access to the repository - * can use this endpoint. If the repository is private you must use an access token - * with the `repo` scope. GitHub Apps must have the `actions:read` permission to - * use this endpoint. + * Gets a specific workflow run attempt. + * + * 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. */ getWorkflowRunAttempt: { ( @@ -1202,7 +1207,9 @@ export type RestEndpointMethods = { /** * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ getWorkflowRunUsage: { ( @@ -1216,7 +1223,11 @@ export type RestEndpointMethods = { /** * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * Anyone with read access to the repository can use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ getWorkflowUsage: { ( @@ -1228,7 +1239,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Lists all artifacts for a repository. + * + * 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. */ listArtifactsForRepo: { ( @@ -1243,9 +1258,9 @@ export type RestEndpointMethods = { * Lists all secrets available in an environment without revealing their * encrypted values. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ listEnvironmentSecrets: { ( @@ -1259,9 +1274,9 @@ export type RestEndpointMethods = { /** * Lists all environment variables. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ listEnvironmentVariables: { ( @@ -1273,7 +1288,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * Lists jobs for a workflow run. 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). + * + * 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. */ listJobsForWorkflowRun: { ( @@ -1285,7 +1305,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * Lists jobs for a specific workflow run attempt. 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). + * + * 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. */ listJobsForWorkflowRunAttempt: { ( @@ -1299,10 +1324,9 @@ export type RestEndpointMethods = { /** * Lists all labels for a self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ listLabelsForSelfHostedRunnerForOrg: { ( @@ -1316,9 +1340,9 @@ export type RestEndpointMethods = { /** * Lists all labels for a self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ listLabelsForSelfHostedRunnerForRepo: { ( @@ -1333,10 +1357,9 @@ export type RestEndpointMethods = { * Lists all secrets available in an organization without revealing their * encrypted values. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ listOrgSecrets: { ( @@ -1349,7 +1372,10 @@ export type RestEndpointMethods = { }; /** * Lists all organization variables. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ listOrgVariables: { ( @@ -1364,9 +1390,9 @@ export type RestEndpointMethods = { * Lists all organization secrets shared with a repository without revealing their encrypted * values. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ listRepoOrganizationSecrets: { ( @@ -1378,11 +1404,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all organiation variables shared with a repository. + * Lists all organization variables shared with a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ listRepoOrganizationVariables: { ( @@ -1397,9 +1423,9 @@ export type RestEndpointMethods = { * Lists all secrets available in a repository without revealing their encrypted * values. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ listRepoSecrets: { ( @@ -1412,9 +1438,10 @@ export type RestEndpointMethods = { }; /** * Lists all repository variables. - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ listRepoVariables: { ( @@ -1426,7 +1453,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Lists the workflows in a repository. + * + * 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. */ listRepoWorkflows: { ( @@ -1440,10 +1471,9 @@ export type RestEndpointMethods = { /** * Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ listRunnerApplicationsForOrg: { ( @@ -1457,9 +1487,9 @@ export type RestEndpointMethods = { /** * Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ listRunnerApplicationsForRepo: { ( @@ -1474,10 +1504,9 @@ export type RestEndpointMethods = { * Lists all repositories that have been selected when the `visibility` * for repository access to a secret is set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ listSelectedReposForOrgSecret: { ( @@ -1492,10 +1521,9 @@ export type RestEndpointMethods = { * Lists all repositories that can access an organization variable * that is available to selected repositories. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ listSelectedReposForOrgVariable: { ( @@ -1509,7 +1537,7 @@ export type RestEndpointMethods = { /** * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ listSelectedRepositoriesEnabledGithubActionsOrganization: { ( @@ -1523,10 +1551,9 @@ export type RestEndpointMethods = { /** * Lists all self-hosted runners configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ listSelfHostedRunnersForOrg: { ( @@ -1540,9 +1567,9 @@ export type RestEndpointMethods = { /** * Lists all self-hosted runners configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ listSelfHostedRunnersForRepo: { ( @@ -1554,7 +1581,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Lists artifacts for a workflow run. + * + * 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. */ listWorkflowRunArtifacts: { ( @@ -1566,9 +1597,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + * + * Anyone with read access to the repository can use this endpoint * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ listWorkflowRuns: { ( @@ -1580,9 +1613,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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/overview/resources-in-the-rest-api#parameters). + * 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). * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ listWorkflowRunsForRepo: { ( @@ -1596,8 +1631,7 @@ export type RestEndpointMethods = { /** * Re-run a job and its dependent jobs in a workflow run. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * 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. */ reRunJobForWorkflowRun: { ( @@ -1609,7 +1643,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * Re-runs your workflow run using its `id`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ reRunWorkflow: { ( @@ -1621,7 +1657,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. + * Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ reRunWorkflowFailedJobs: { ( @@ -1636,10 +1674,9 @@ export type RestEndpointMethods = { * Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ removeAllCustomLabelsFromSelfHostedRunnerForOrg: { ( @@ -1654,9 +1691,9 @@ export type RestEndpointMethods = { * Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ removeAllCustomLabelsFromSelfHostedRunnerForRepo: { ( @@ -1674,10 +1711,9 @@ export type RestEndpointMethods = { * This endpoint returns a `404 Not Found` status if the custom label is not * present on the runner. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ removeCustomLabelFromSelfHostedRunnerForOrg: { ( @@ -1695,9 +1731,9 @@ export type RestEndpointMethods = { * This endpoint returns a `404 Not Found` status if the custom label is not * present on the runner. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ removeCustomLabelFromSelfHostedRunnerForRepo: { ( @@ -1713,10 +1749,9 @@ export type RestEndpointMethods = { * for repository access is set to `selected`. The visibility is set when you [Create * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ removeSelectedRepoFromOrgSecret: { ( @@ -1732,10 +1767,9 @@ export type RestEndpointMethods = { * available to selected repositories. Organization variables that are available to * selected repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ removeSelectedRepoFromOrgVariable: { ( @@ -1752,8 +1786,7 @@ export type RestEndpointMethods = { * **Note:** GitHub Apps can only review their own custom deployment protection rules. * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have read and write permission for **Deployments** to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ reviewCustomGatesForRun: { ( @@ -1767,7 +1800,9 @@ export type RestEndpointMethods = { /** * Approve or reject pending deployments that are waiting on approval by a required reviewer. * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint. + * Required reviewers with read access to the repository contents and deployments can use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ reviewPendingDeploymentsForRun: { ( @@ -1781,7 +1816,7 @@ export type RestEndpointMethods = { /** * Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ setAllowedActionsOrganization: { ( @@ -1795,7 +1830,7 @@ export type RestEndpointMethods = { /** * Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ setAllowedActionsRepository: { ( @@ -1810,10 +1845,9 @@ export type RestEndpointMethods = { * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ setCustomLabelsForSelfHostedRunnerForOrg: { ( @@ -1828,9 +1862,9 @@ export type RestEndpointMethods = { * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ setCustomLabelsForSelfHostedRunnerForRepo: { ( @@ -1846,7 +1880,7 @@ export type RestEndpointMethods = { * can submit approving pull request reviews. For more information, see * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ setGithubActionsDefaultWorkflowPermissionsOrganization: { ( @@ -1862,7 +1896,7 @@ export type RestEndpointMethods = { * can submit approving pull request reviews. * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ setGithubActionsDefaultWorkflowPermissionsRepository: { ( @@ -1876,7 +1910,7 @@ export type RestEndpointMethods = { /** * Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ setGithubActionsPermissionsOrganization: { ( @@ -1890,7 +1924,7 @@ export type RestEndpointMethods = { /** * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ setGithubActionsPermissionsRepository: { ( @@ -1906,10 +1940,9 @@ export type RestEndpointMethods = { * for repository access is set to `selected`. The visibility is set when you [Create * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ setSelectedReposForOrgSecret: { ( @@ -1925,11 +1958,9 @@ export type RestEndpointMethods = { * to selected repositories. Organization variables that are available to selected * repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this - * endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ setSelectedReposForOrgVariable: { ( @@ -1943,7 +1974,8 @@ export type RestEndpointMethods = { /** * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ setSelectedRepositoriesEnabledGithubActionsOrganization: { ( @@ -1959,8 +1991,7 @@ export type RestEndpointMethods = { * This endpoint only applies to private repositories. * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - * repository `administration` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ setWorkflowAccessToRepository: { ( @@ -1974,9 +2005,9 @@ export type RestEndpointMethods = { /** * Updates an environment variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ updateEnvironmentVariable: { ( @@ -1990,10 +2021,9 @@ export type RestEndpointMethods = { /** * Updates an organization variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ updateOrgVariable: { ( @@ -2007,9 +2037,9 @@ export type RestEndpointMethods = { /** * Updates a repository variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ updateRepoVariable: { ( @@ -2062,7 +2092,7 @@ export type RestEndpointMethods = { * 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: * * * **Timeline**: The GitHub global public timeline - * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + * * **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)." * * **Current user public**: The public timeline for the authenticated user * * **Current user**: The private timeline for the authenticated user * * **Current user actor**: The private timeline for activity created by the authenticated user @@ -2193,7 +2223,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ listReceivedEventsForUser: { ( @@ -2241,7 +2271,9 @@ export type RestEndpointMethods = { /** * Lists repositories the authenticated user has starred. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * This 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)." + * + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ listReposStarredByAuthenticatedUser: { ( @@ -2255,7 +2287,9 @@ export type RestEndpointMethods = { /** * Lists repositories a user has starred. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * This 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)." + * + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ listReposStarredByUser: { ( @@ -2281,7 +2315,9 @@ export type RestEndpointMethods = { /** * Lists the people that have starred the repository. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * This 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)." + * + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ listStargazersForRepo: { ( @@ -2340,6 +2376,18 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications. + */ + markThreadAsDone: { + ( + params?: RestEndpointMethodTypes["activity"]["markThreadAsDone"]["parameters"], + ): Promise< + RestEndpointMethodTypes["activity"]["markThreadAsDone"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications. */ @@ -2381,7 +2429,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ starRepoForAuthenticatedUser: { ( @@ -2408,8 +2456,6 @@ export type RestEndpointMethods = { apps: { /** * Add a single repository to an installation. The authenticated user must have admin access to the repository. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. * @deprecated octokit.rest.apps.addRepoToInstallation() has been renamed to octokit.rest.apps.addRepoToInstallationForAuthenticatedUser() (2021-10-05) */ addRepoToInstallation: { @@ -2423,8 +2469,6 @@ export type RestEndpointMethods = { }; /** * Add a single repository to an installation. The authenticated user must have admin access to the repository. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ addRepoToInstallationForAuthenticatedUser: { ( @@ -2458,7 +2502,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. + * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. + * + * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + * + * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. + * + * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ @@ -2524,8 +2574,6 @@ export type RestEndpointMethods = { }; /** * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - * - * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ getBySlug: { ( @@ -2679,8 +2727,6 @@ export type RestEndpointMethods = { * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - * * The access the user has to each repository is included in the hash under the `permissions` key. */ listInstallationReposForAuthenticatedUser: { @@ -2721,8 +2767,6 @@ export type RestEndpointMethods = { /** * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * * You can find the permissions for the installation under the `permissions` key. @@ -2764,8 +2808,6 @@ export type RestEndpointMethods = { }; /** * List repositories that an app installation can access. - * - * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ listReposAccessibleToInstallation: { ( @@ -2777,7 +2819,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + * Lists the active subscriptions for the authenticated user. */ listSubscriptionsForAuthenticatedUser: { ( @@ -2789,7 +2831,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + * Lists the active subscriptions for the authenticated user. */ listSubscriptionsForAuthenticatedUserStubbed: { ( @@ -2830,8 +2872,6 @@ export type RestEndpointMethods = { }; /** * Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. * @deprecated octokit.rest.apps.removeRepoFromInstallation() has been renamed to octokit.rest.apps.removeRepoFromInstallationForAuthenticatedUser() (2021-10-05) */ removeRepoFromInstallation: { @@ -2845,8 +2885,6 @@ export type RestEndpointMethods = { }; /** * Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ removeRepoFromInstallationForAuthenticatedUser: { ( @@ -2871,8 +2909,6 @@ export type RestEndpointMethods = { * Revokes the installation token you're using to authenticate as an installation and access this endpoint. * * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - * - * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ revokeInstallationAccessToken: { ( @@ -2884,7 +2920,15 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. + * Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify + * which repositories the token can access and which permissions are granted to the + * token. + * + * Invalid tokens will return `404 NOT FOUND`. + * + * You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) + * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + * as the username and password. */ scopeToken: { ( @@ -2942,7 +2986,7 @@ export type RestEndpointMethods = { * * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ getGithubActionsBillingOrg: { ( @@ -2958,7 +3002,7 @@ export type RestEndpointMethods = { * * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ getGithubActionsBillingUser: { ( @@ -2974,7 +3018,7 @@ export type RestEndpointMethods = { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ getGithubPackagesBillingOrg: { ( @@ -2990,7 +3034,7 @@ export type RestEndpointMethods = { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ getGithubPackagesBillingUser: { ( @@ -3006,7 +3050,7 @@ export type RestEndpointMethods = { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ getSharedStorageBillingOrg: { ( @@ -3022,7 +3066,7 @@ export type RestEndpointMethods = { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ getSharedStorageBillingUser: { ( @@ -3050,9 +3094,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** + * Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". + * * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ createSuite: { ( @@ -3062,9 +3108,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** + * Gets a single check run using its `id`. + * * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: { ( @@ -3074,9 +3122,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** + * Gets a single check suite using its `id`. + * * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ getSuite: { ( @@ -3086,7 +3136,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. + * Lists annotations for a check run using the annotation `id`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ listAnnotations: { ( @@ -3098,11 +3150,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ listForRef: { ( @@ -3112,9 +3166,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * Lists check runs for a check suite using its `id`. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ listForSuite: { ( @@ -3124,9 +3180,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ listSuitesForRef: { ( @@ -3140,9 +3198,9 @@ export type RestEndpointMethods = { /** * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. - * * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ rerequestRun: { ( @@ -3154,7 +3212,7 @@ export type RestEndpointMethods = { /** * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ rerequestSuite: { ( @@ -3166,7 +3224,8 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. + * Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). + * You must have admin permissions in the repository to set preferences for check suites. */ setSuitesPreferences: { ( @@ -3178,9 +3237,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * Updates a check run for a specific commit in a repository. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ update: { ( @@ -3192,10 +3253,7 @@ export type RestEndpointMethods = { }; codeScanning: { /** - * Deletes a specified code scanning analysis from a repository. For - * private repositories, you must use an access token with the `repo` scope. For public repositories, - * you must use an access token with `public_repo` scope. - * GitHub Apps must have the `security_events` write permission to use this endpoint. + * Deletes a specified code scanning analysis from a repository. * * You can delete one analysis at a time. * To delete a series of analyses, start with the most recent analysis and work backwards. @@ -3257,6 +3315,8 @@ export type RestEndpointMethods = { * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ deleteAnalysis: { ( @@ -3268,7 +3328,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. + * Gets a single code scanning alert. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ getAlert: { ( @@ -3281,9 +3343,6 @@ export type RestEndpointMethods = { }; /** * Gets a specified code scanning analysis for a repository. - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. * * The default JSON response contains fields that describe the analysis. * This includes the Git reference and commit SHA to which the analysis relates, @@ -3295,10 +3354,11 @@ export type RestEndpointMethods = { * For very old analyses this data is not available, * and `0` is returned in this field. * - * If you use the Accept header `application/sarif+json`, - * the response contains the analysis data that was uploaded. - * This is formatted as - * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + * This 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)." + * + * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ getAnalysis: { ( @@ -3318,9 +3378,7 @@ export type RestEndpointMethods = { * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * For private repositories, you must use an access token with the `security_events` scope. - * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - * GitHub Apps must have the `contents` read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ getCodeqlDatabase: { ( @@ -3333,8 +3391,8 @@ export type RestEndpointMethods = { }; /** * Gets a code scanning default setup configuration. - * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ getDefaultSetup: { ( @@ -3346,7 +3404,8 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. + * Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ getSarif: { ( @@ -3359,9 +3418,8 @@ export type RestEndpointMethods = { }; /** * Lists all instances of the specified code scanning alert. - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ listAlertInstances: { ( @@ -3375,11 +3433,9 @@ export type RestEndpointMethods = { /** * Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - * - * For public repositories, you may instead use the `public_repo` scope. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * GitHub Apps must have the `security_events` read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ listAlertsForOrg: { ( @@ -3413,9 +3469,8 @@ export type RestEndpointMethods = { }; /** * Lists all instances of the specified code scanning alert. - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. * @deprecated octokit.rest.codeScanning.listAlertsInstances() has been renamed to octokit.rest.codeScanning.listAlertInstances() (2021-04-30) */ listAlertsInstances: { @@ -3430,9 +3485,7 @@ export type RestEndpointMethods = { /** * Lists the CodeQL databases that are available in a repository. * - * For private repositories, you must use an access token with the `security_events` scope. - * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - * GitHub Apps must have the `contents` read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ listCodeqlDatabases: { ( @@ -3455,12 +3508,10 @@ export type RestEndpointMethods = { * For very old analyses this data is not available, * and `0` is returned in this field. * - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. - * * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ listRecentAnalyses: { ( @@ -3472,7 +3523,8 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. + * Updates the status of a single code scanning alert. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ updateAlert: { ( @@ -3485,8 +3537,8 @@ export type RestEndpointMethods = { }; /** * Updates a code scanning default setup configuration. - * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ updateDefaultSetup: { ( @@ -3498,7 +3550,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." + * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -3509,7 +3561,7 @@ export type RestEndpointMethods = { * ``` * gzip -c analysis-data.sarif | base64 -w0 * ``` - *
+ * * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * @@ -3528,6 +3580,8 @@ export type RestEndpointMethods = { * The `202 Accepted` response includes an `id` value. * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ uploadSarif: { ( @@ -3567,9 +3621,11 @@ export type RestEndpointMethods = { }; codespaces: { /** - * Adds a repository to the selected repositories for a user's codespace secret. - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. + * Adds a repository to the selected repositories for a user's development environment secret. + * + * The authenticated user must have Codespaces access to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ addRepositoryForSecretForAuthenticatedUser: { ( @@ -3581,7 +3637,8 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ addSelectedRepoToOrgSecret: { ( @@ -3595,9 +3652,7 @@ export type RestEndpointMethods = { /** * Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ checkPermissionsForDevcontainer: { ( @@ -3611,9 +3666,7 @@ export type RestEndpointMethods = { /** * List the machine types a codespace can transition to use. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ codespaceMachinesForAuthenticatedUser: { ( @@ -3629,9 +3682,7 @@ export type RestEndpointMethods = { * * This endpoint requires either a `repository_id` OR a `pull_request` but not both. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ createForAuthenticatedUser: { ( @@ -3643,11 +3694,10 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates or updates an organization secret with an encrypted value. Encrypt your secret using + * Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ createOrUpdateOrgSecret: { ( @@ -3659,12 +3709,10 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates or updates a repository secret with an encrypted value. Encrypt your secret using + * Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * You must authenticate using an access - * token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - * repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createOrUpdateRepoSecret: { ( @@ -3676,12 +3724,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using + * Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ createOrUpdateSecretForAuthenticatedUser: { ( @@ -3695,9 +3743,7 @@ export type RestEndpointMethods = { /** * Creates a codespace owned by the authenticated user for the specified pull request. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ createWithPrForAuthenticatedUser: { ( @@ -3711,9 +3757,7 @@ export type RestEndpointMethods = { /** * Creates a codespace owned by the authenticated user in the specified repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ createWithRepoForAuthenticatedUser: { ( @@ -3727,9 +3771,7 @@ export type RestEndpointMethods = { /** * Deletes a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ deleteForAuthenticatedUser: { ( @@ -3743,10 +3785,7 @@ export type RestEndpointMethods = { /** * Deletes a user's codespace. * - * To use this endpoint you must authenticate using one of the following methods: - * - * - An access token with the `admin:org` scope - * - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ deleteFromOrganization: { ( @@ -3758,7 +3797,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Deletes an organization secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * Deletes an organization development environment secret using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ deleteOrgSecret: { ( @@ -3770,7 +3811,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * Deletes a development environment secret in a repository using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteRepoSecret: { ( @@ -3782,11 +3825,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. + * Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ deleteSecretForAuthenticatedUser: { ( @@ -3802,9 +3845,7 @@ export type RestEndpointMethods = { * * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ exportForAuthenticatedUser: { ( @@ -3818,7 +3859,7 @@ export type RestEndpointMethods = { /** * Lists the codespaces that a member of an organization has for repositories in that organization. * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ getCodespacesForUserInOrg: { ( @@ -3832,9 +3873,7 @@ export type RestEndpointMethods = { /** * Gets information about an export of a codespace. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ getExportDetailsForAuthenticatedUser: { ( @@ -3848,9 +3887,7 @@ export type RestEndpointMethods = { /** * Gets information about a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ getForAuthenticatedUser: { ( @@ -3862,7 +3899,8 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ getOrgPublicKey: { ( @@ -3874,8 +3912,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets an organization secret without revealing its encrypted value. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * Gets an organization development environment secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ getOrgSecret: { ( @@ -3889,9 +3928,9 @@ export type RestEndpointMethods = { /** * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ getPublicKeyForAuthenticatedUser: { ( @@ -3903,7 +3942,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getRepoPublicKey: { ( @@ -3915,7 +3959,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * Gets a single repository development environment secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getRepoSecret: { ( @@ -3927,11 +3973,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a secret available to a user's codespaces without revealing its encrypted value. + * Gets a development environment secret available to a user's codespaces without revealing its encrypted value. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ getSecretForAuthenticatedUser: { ( @@ -3946,9 +3992,7 @@ export type RestEndpointMethods = { * Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files * specify launchpoint configurations for codespaces created within the repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ listDevcontainersInRepositoryForAuthenticatedUser: { ( @@ -3962,9 +4006,7 @@ export type RestEndpointMethods = { /** * Lists the authenticated user's codespaces. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ listForAuthenticatedUser: { ( @@ -3978,7 +4020,7 @@ export type RestEndpointMethods = { /** * Lists the codespaces associated to a specified organization. * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ listInOrganization: { ( @@ -3992,9 +4034,7 @@ export type RestEndpointMethods = { /** * Lists the codespaces associated to a specified repository and the authenticated user. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ listInRepositoryForAuthenticatedUser: { ( @@ -4006,8 +4046,10 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all Codespaces secrets available at the organization-level without revealing their encrypted values. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ listOrgSecrets: { ( @@ -4019,7 +4061,10 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * Lists all development environment secrets available in a repository without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ listRepoSecrets: { ( @@ -4031,11 +4076,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the repositories that have been granted the ability to use a user's codespace secret. + * List the repositories that have been granted the ability to use a user's development environment secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ listRepositoriesForSecretForAuthenticatedUser: { ( @@ -4047,12 +4092,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all secrets available for a user's Codespaces without revealing their + * Lists all development environment secrets available for a user's codespaces without revealing their * encrypted values. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ listSecretsForAuthenticatedUser: { ( @@ -4064,7 +4109,10 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * Lists all repositories that have been selected when the `visibility` + * for repository access to a secret is set to `selected`. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ listSelectedReposForOrgSecret: { ( @@ -4078,9 +4126,7 @@ export type RestEndpointMethods = { /** * Gets the default attributes for codespaces created by the user with the repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ preFlightWithRepoForAuthenticatedUser: { ( @@ -4098,9 +4144,7 @@ export type RestEndpointMethods = { * * This will fail for a codespace that is already published, meaning it has an associated repository. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ publishForAuthenticatedUser: { ( @@ -4112,9 +4156,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Removes a repository from the selected repositories for a user's codespace secret. - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + * Removes a repository from the selected repositories for a user's development environment secret. + * + * The authenticated user must have Codespaces access to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ removeRepositoryForSecretForAuthenticatedUser: { ( @@ -4126,7 +4172,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * Removes a repository from an organization development environment secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ removeSelectedRepoFromOrgSecret: { ( @@ -4140,9 +4190,7 @@ export type RestEndpointMethods = { /** * List the machine types available for a given repository based on its configuration. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ repoMachinesForAuthenticatedUser: { ( @@ -4154,11 +4202,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Select the repositories that will use a user's codespace secret. + * Select the repositories that will use a user's development environment secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ setRepositoriesForSecretForAuthenticatedUser: { ( @@ -4170,7 +4218,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * Replaces all repositories for an organization development environment secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ setSelectedReposForOrgSecret: { ( @@ -4184,9 +4236,7 @@ export type RestEndpointMethods = { /** * Starts a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ startForAuthenticatedUser: { ( @@ -4200,9 +4250,7 @@ export type RestEndpointMethods = { /** * Stops a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ stopForAuthenticatedUser: { ( @@ -4216,10 +4264,7 @@ export type RestEndpointMethods = { /** * Stops a user's codespace. * - * To use this endpoint you must authenticate using one of the following methods: - * - * - An access token with the `admin:org` scope - * - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ stopInOrganization: { ( @@ -4235,9 +4280,7 @@ export type RestEndpointMethods = { * * If you specify a new machine type it will be applied the next time your codespace is started. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ updateForAuthenticatedUser: { ( @@ -4253,21 +4296,22 @@ export type RestEndpointMethods = { /** * **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)". + * Purchases a GitHub Copilot seat for all users within each specified team. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * 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. + * Only organization owners can configure GitHub Copilot in their organization. * - * 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)". + * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * 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/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ - addCopilotForBusinessSeatsForTeams: { + addCopilotSeatsForTeams: { ( - params?: RestEndpointMethodTypes["copilot"]["addCopilotForBusinessSeatsForTeams"]["parameters"], + params?: RestEndpointMethodTypes["copilot"]["addCopilotSeatsForTeams"]["parameters"], ): Promise< - RestEndpointMethodTypes["copilot"]["addCopilotForBusinessSeatsForTeams"]["response"] + RestEndpointMethodTypes["copilot"]["addCopilotSeatsForTeams"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; @@ -4275,21 +4319,22 @@ export type RestEndpointMethods = { /** * **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)". + * Purchases a GitHub Copilot seat for each user specified. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * + * Only organization owners can configure GitHub Copilot in their organization. * - * 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 Business or Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * 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/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * - * 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)". + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ - addCopilotForBusinessSeatsForUsers: { + addCopilotSeatsForUsers: { ( - params?: RestEndpointMethodTypes["copilot"]["addCopilotForBusinessSeatsForUsers"]["parameters"], + params?: RestEndpointMethodTypes["copilot"]["addCopilotSeatsForUsers"]["parameters"], ): Promise< - RestEndpointMethodTypes["copilot"]["addCopilotForBusinessSeatsForUsers"]["response"] + RestEndpointMethodTypes["copilot"]["addCopilotSeatsForUsers"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; @@ -4297,15 +4342,16 @@ export type RestEndpointMethods = { /** * **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot for Business seat assignment for all members of each team specified. + * Cancels the Copilot seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * 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)". + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * 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. + * Only organization owners can configure GitHub Copilot in their organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ cancelCopilotSeatAssignmentForTeams: { ( @@ -4319,15 +4365,16 @@ export type RestEndpointMethods = { /** * **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot for Business seat assignment for each user specified. + * Cancels the Copilot seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * 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)" + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * Only organization owners can configure GitHub Copilot in their organization. * - * 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. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ cancelCopilotSeatAssignmentForUsers: { ( @@ -4341,12 +4388,13 @@ export type RestEndpointMethods = { /** * **Note**: This endpoint is in beta and is subject to change. * - * Gets information about an organization's Copilot for Business subscription, including seat breakdown + * Gets information about an organization's Copilot subscription, including seat breakdown * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Configuring GitHub Copilot settings in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)". + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure and view details about the organization's Copilot Business subscription. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ getCopilotOrganizationDetails: { ( @@ -4360,9 +4408,11 @@ export type RestEndpointMethods = { /** * **Note**: This endpoint is in beta and is subject to change. * - * Gets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * + * Organization owners can view GitHub Copilot seat assignment details for members in their organization. * - * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ getCopilotSeatDetailsForUser: { ( @@ -4376,10 +4426,11 @@ export type RestEndpointMethods = { /** * **Note**: This endpoint is in beta and is subject to change. * - * Lists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ listCopilotSeats: { ( @@ -4393,7 +4444,11 @@ export type RestEndpointMethods = { }; dependabot: { /** - * Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * Adds a repository to an organization secret when the `visibility` for + * repository access is set to `selected`. The visibility is set when you [Create or + * update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ addSelectedRepoToOrgSecret: { ( @@ -4494,9 +4549,7 @@ export type RestEndpointMethods = { * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * You must authenticate using an access - * token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository - * permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createOrUpdateRepoSecret: { ( @@ -4508,7 +4561,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * Deletes a secret in an organization using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ deleteOrgSecret: { ( @@ -4520,7 +4575,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * Deletes a secret in a repository using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteRepoSecret: { ( @@ -4532,9 +4589,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ getAlert: { ( @@ -4544,7 +4599,10 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ getOrgPublicKey: { ( @@ -4556,7 +4614,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * Gets a single organization secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ getOrgSecret: { ( @@ -4568,7 +4628,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. Anyone with read access + * to the repository can use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. */ getRepoPublicKey: { ( @@ -4580,7 +4644,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * Gets a single repository secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getRepoSecret: { ( @@ -4593,9 +4659,12 @@ export type RestEndpointMethods = { }; /** * Lists Dependabot alerts for repositories that are owned by the specified enterprise. - * To use this endpoint, you must be a member of the enterprise, and you must use an - * access token with the `repo` scope or `security_events` scope. + * + * The authenticated user must be a member of the enterprise to use this endpoint. + * * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ listAlertsForEnterprise: { ( @@ -4609,11 +4678,9 @@ export type RestEndpointMethods = { /** * Lists Dependabot alerts for an organization. * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - * - * For public repositories, you may instead use the `public_repo` scope. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ listAlertsForOrg: { ( @@ -4625,9 +4692,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ listAlertsForRepo: { ( @@ -4639,7 +4704,10 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * Lists all secrets available in an organization without revealing their + * encrypted values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ listOrgSecrets: { ( @@ -4651,7 +4719,10 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * Lists all secrets available in a repository without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ listRepoSecrets: { ( @@ -4663,7 +4734,10 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * Lists all repositories that have been selected when the `visibility` + * for repository access to a secret is set to `selected`. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ listSelectedReposForOrgSecret: { ( @@ -4675,7 +4749,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * Removes a repository from an organization secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ removeSelectedRepoFromOrgSecret: { ( @@ -4687,7 +4765,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * Replaces all repositories for an organization secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ setSelectedReposForOrgSecret: { ( @@ -4699,11 +4781,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** write permission to use this endpoint. + * The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * - * To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ updateAlert: { ( @@ -4717,7 +4797,11 @@ export type RestEndpointMethods = { }; dependencyGraph: { /** - * Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to. + * Create a new snapshot of a repository's dependencies. + * + * The authenticated user must have access to the repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createRepositorySnapshot: { ( @@ -4787,7 +4871,14 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Creates a comment on a gist. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ createComment: { ( params?: RestEndpointMethodTypes["gists"]["createComment"]["parameters"], @@ -4819,7 +4910,14 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Gets a specified gist. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ get: { ( params?: RestEndpointMethodTypes["gists"]["get"]["parameters"], @@ -4827,7 +4925,14 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Gets a comment on a gist. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ getComment: { ( params?: RestEndpointMethodTypes["gists"]["getComment"]["parameters"], @@ -4835,7 +4940,14 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Gets a specified gist revision. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ getRevision: { ( params?: RestEndpointMethodTypes["gists"]["getRevision"]["parameters"], @@ -4853,7 +4965,14 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Lists the comments on a gist. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ listComments: { ( params?: RestEndpointMethodTypes["gists"]["listComments"]["parameters"], @@ -4890,7 +5009,7 @@ export type RestEndpointMethods = { /** * List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ listPublic: { ( @@ -4910,7 +5029,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ star: { ( @@ -4937,7 +5056,14 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Updates a comment on a gist. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ updateComment: { ( params?: RestEndpointMethodTypes["gists"]["updateComment"]["parameters"], @@ -5067,7 +5193,12 @@ export type RestEndpointMethods = { /** * The `content` in the response will always be Base64 encoded. * - * _Note_: This API supports blobs up to 100 megabytes in size. + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw blob data. + * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + * + * **Note** This endpoint supports blobs up to 100 megabytes in size. */ getBlob: { ( @@ -5222,8 +5353,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * The API also allows fetching the source of a single template. - * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. + * Get the content of a gitignore template. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ getTemplate: { ( @@ -5440,7 +5574,15 @@ export type RestEndpointMethods = { /** * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ create: { ( @@ -5454,9 +5596,15 @@ export type RestEndpointMethods = { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). * Creating content too quickly using this endpoint may result in secondary rate limiting. - * See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" - * and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" - * for details. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ createComment: { ( @@ -5524,7 +5672,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was + * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read @@ -5535,6 +5683,13 @@ export type RestEndpointMethods = { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: { ( @@ -5545,6 +5700,13 @@ export type RestEndpointMethods = { }; /** * You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ getComment: { ( @@ -5588,11 +5750,17 @@ export type RestEndpointMethods = { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ list: { ( @@ -5617,6 +5785,13 @@ export type RestEndpointMethods = { * You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * * Issue comments are ordered by ascending ID. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ listComments: { ( @@ -5629,6 +5804,13 @@ export type RestEndpointMethods = { * You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. * * By default, issue comments are ordered by ascending ID. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ listCommentsForRepo: { ( @@ -5680,6 +5862,13 @@ export type RestEndpointMethods = { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ listForAuthenticatedUser: { ( @@ -5697,6 +5886,13 @@ export type RestEndpointMethods = { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ listForOrg: { ( @@ -5712,6 +5908,13 @@ export type RestEndpointMethods = { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ listForRepo: { ( @@ -5771,7 +5974,7 @@ export type RestEndpointMethods = { /** * Users with push access can lock an issue or pull request's conversation. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ lock: { ( @@ -5836,6 +6039,13 @@ export type RestEndpointMethods = { }; /** * Issue owners and users with push access can edit an issue. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ update: { ( @@ -5846,6 +6056,13 @@ export type RestEndpointMethods = { }; /** * You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ updateComment: { ( @@ -5903,7 +6120,10 @@ export type RestEndpointMethods = { /** * This method returns the contents of the repository's license file, if one is detected. * - * Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. + * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ getForRepo: { ( @@ -6385,9 +6605,9 @@ export type RestEndpointMethods = { /** * Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ addSecurityManagerTeam: { ( @@ -6398,6 +6618,38 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + assignTeamToOrgRole: { + ( + params?: RestEndpointMethodTypes["orgs"]["assignTeamToOrgRole"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["assignTeamToOrgRole"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + assignUserToOrgRole: { + ( + params?: RestEndpointMethodTypes["orgs"]["assignUserToOrgRole"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["assignUserToOrgRole"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned. */ @@ -6470,10 +6722,30 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + createCustomOrganizationRole: { + ( + params?: RestEndpointMethodTypes["orgs"]["createCustomOrganizationRole"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["createCustomOrganizationRole"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ createInvitation: { ( @@ -6486,7 +6758,10 @@ export type RestEndpointMethods = { }; /** * Creates new or updates existing custom properties defined for an organization in a batch. - * Only organization owners (or users with the proper permissions granted by them) can update these properties + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ createOrUpdateCustomProperties: { ( @@ -6505,7 +6780,9 @@ export type RestEndpointMethods = { * * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. * - * Only organization owners (or users with the proper permissions granted by them) can update these properties + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. */ createOrUpdateCustomPropertiesValuesForRepos: { ( @@ -6518,7 +6795,10 @@ export type RestEndpointMethods = { }; /** * Creates a new or updates an existing custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ createOrUpdateCustomProperty: { ( @@ -6555,6 +6835,25 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + deleteCustomOrganizationRole: { + ( + params?: RestEndpointMethodTypes["orgs"]["deleteCustomOrganizationRole"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["deleteCustomOrganizationRole"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; deleteWebhook: { ( @@ -6564,14 +6863,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Enables or disables the specified security feature for all eligible repositories in an organization. - * - * To use this endpoint, you must be an organization owner or be member of a team with the security manager role. - * A token with the 'write:org' scope is also required. + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ enableOrDisableSecurityProductOnAllOrgRepos: { ( @@ -6583,9 +6879,15 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * Gets information about an organization. * - * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * + * To see the full details about an organization, the authenticated user must be an organization owner. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + * + * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. */ get: { ( @@ -6596,7 +6898,7 @@ export type RestEndpointMethods = { }; /** * Gets all custom properties defined for an organization. - * You must be an organization owner to use this endpoint. + * Organization members can read these properties. */ getAllCustomProperties: { ( @@ -6609,7 +6911,7 @@ export type RestEndpointMethods = { }; /** * Gets a custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * Organization members can read these properties. */ getCustomProperty: { ( @@ -6644,6 +6946,23 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + getOrgRole: { + ( + params?: RestEndpointMethodTypes["orgs"]["getOrgRole"]["parameters"], + ): Promise; + defaults: RequestInterface["defaults"]; + 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)." */ @@ -6657,7 +6976,7 @@ 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)." * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. */ getWebhookConfigForOrg: { ( @@ -6693,7 +7012,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. + * Lists all GitHub Apps in an organization. The installation count includes + * all GitHub Apps installed on repositories in the organization. + * + * The authenticated user must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. */ listAppInstallations: { ( @@ -6744,9 +7068,7 @@ export type RestEndpointMethods = { /** * List organizations for the authenticated user. * - * **OAuth scope requirements** - * - * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. */ listForAuthenticatedUser: { ( @@ -6803,6 +7125,76 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, you must be an administrator for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + listOrgRoleTeams: { + ( + params?: RestEndpointMethodTypes["orgs"]["listOrgRoleTeams"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["listOrgRoleTeams"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, you must be an administrator for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + listOrgRoleUsers: { + ( + params?: RestEndpointMethodTypes["orgs"]["listOrgRoleUsers"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["listOrgRoleUsers"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + listOrgRoles: { + ( + params?: RestEndpointMethodTypes["orgs"]["listOrgRoles"]["parameters"], + ): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + listOrganizationFineGrainedPermissions: { + ( + params?: RestEndpointMethodTypes["orgs"]["listOrganizationFineGrainedPermissions"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["listOrganizationFineGrainedPermissions"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * List all users who are outside collaborators of an organization. */ @@ -6816,10 +7208,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: read` permission. + * Lists the repositories a fine-grained personal access token has access to. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ listPatGrantRepositories: { ( @@ -6831,10 +7222,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: read` permission. + * Lists the repositories a fine-grained personal access token request is requesting access to. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ listPatGrantRequestRepositories: { ( @@ -6846,10 +7236,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: read` permission. + * Lists requests from organization members to access organization resources with a fine-grained personal access token. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ listPatGrantRequests: { ( @@ -6861,10 +7250,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: read` permission. + * Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ listPatGrants: { ( @@ -6900,9 +7288,9 @@ export type RestEndpointMethods = { /** * Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ listSecurityManagerTeams: { ( @@ -6933,6 +7321,26 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patchCustomOrganizationRole: { + ( + params?: RestEndpointMethodTypes["orgs"]["patchCustomOrganizationRole"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["patchCustomOrganizationRole"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ @@ -6957,7 +7365,10 @@ export type RestEndpointMethods = { }; /** * Removes a custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ removeCustomProperty: { ( @@ -7007,57 +7418,119 @@ export type RestEndpointMethods = { /** * Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. */ - removePublicMembershipForAuthenticatedUser: { + removePublicMembershipForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["orgs"]["removePublicMembershipForAuthenticatedUser"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["removePublicMembershipForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + removeSecurityManagerTeam: { + ( + params?: RestEndpointMethodTypes["orgs"]["removeSecurityManagerTeam"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["removeSecurityManagerTeam"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Approves or denies a pending request to access organization resources via a fine-grained personal access token. + * + * Only GitHub Apps can use this endpoint. + */ + reviewPatGrantRequest: { + ( + params?: RestEndpointMethodTypes["orgs"]["reviewPatGrantRequest"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["reviewPatGrantRequest"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. + * + * Only GitHub Apps can use this endpoint. + */ + reviewPatGrantRequestsInBulk: { + ( + params?: RestEndpointMethodTypes["orgs"]["reviewPatGrantRequestsInBulk"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["reviewPatGrantRequestsInBulk"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + revokeAllOrgRolesTeam: { ( - params?: RestEndpointMethodTypes["orgs"]["removePublicMembershipForAuthenticatedUser"]["parameters"], + params?: RestEndpointMethodTypes["orgs"]["revokeAllOrgRolesTeam"]["parameters"], ): Promise< - RestEndpointMethodTypes["orgs"]["removePublicMembershipForAuthenticatedUser"]["response"] + RestEndpointMethodTypes["orgs"]["revokeAllOrgRolesTeam"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; /** - * Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." + * Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - removeSecurityManagerTeam: { + revokeAllOrgRolesUser: { ( - params?: RestEndpointMethodTypes["orgs"]["removeSecurityManagerTeam"]["parameters"], + params?: RestEndpointMethodTypes["orgs"]["revokeAllOrgRolesUser"]["parameters"], ): Promise< - RestEndpointMethodTypes["orgs"]["removeSecurityManagerTeam"]["response"] + RestEndpointMethodTypes["orgs"]["revokeAllOrgRolesUser"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; /** - * Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: write` permission. + * Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - reviewPatGrantRequest: { + revokeOrgRoleTeam: { ( - params?: RestEndpointMethodTypes["orgs"]["reviewPatGrantRequest"]["parameters"], + params?: RestEndpointMethodTypes["orgs"]["revokeOrgRoleTeam"]["parameters"], ): Promise< - RestEndpointMethodTypes["orgs"]["reviewPatGrantRequest"]["response"] + RestEndpointMethodTypes["orgs"]["revokeOrgRoleTeam"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; /** - * Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: write` permission. + * Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - reviewPatGrantRequestsInBulk: { + revokeOrgRoleUser: { ( - params?: RestEndpointMethodTypes["orgs"]["reviewPatGrantRequestsInBulk"]["parameters"], + params?: RestEndpointMethodTypes["orgs"]["revokeOrgRoleUser"]["parameters"], ): Promise< - RestEndpointMethodTypes["orgs"]["reviewPatGrantRequestsInBulk"]["response"] + RestEndpointMethodTypes["orgs"]["revokeOrgRoleUser"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; @@ -7085,7 +7558,7 @@ export type RestEndpointMethods = { /** * The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ setPublicMembershipForAuthenticatedUser: { ( @@ -7109,7 +7582,11 @@ export type RestEndpointMethods = { /** * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. + * Updates the organization's profile and member privileges. + * + * The authenticated user must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ update: { ( @@ -7131,10 +7608,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: write` permission. + * Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ updatePatAccess: { ( @@ -7146,10 +7622,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: write` permission. + * Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ updatePatAccesses: { ( @@ -7173,7 +7648,7 @@ 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)." * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + * OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. */ updateWebhookConfigForOrg: { ( @@ -7189,8 +7664,7 @@ export type RestEndpointMethods = { /** * Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ deletePackageForAuthenticatedUser: { ( @@ -7204,9 +7678,9 @@ export type RestEndpointMethods = { /** * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ deletePackageForOrg: { ( @@ -7220,9 +7694,9 @@ export type RestEndpointMethods = { /** * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ deletePackageForUser: { ( @@ -7236,8 +7710,9 @@ export type RestEndpointMethods = { /** * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ deletePackageVersionForAuthenticatedUser: { ( @@ -7251,9 +7726,9 @@ export type RestEndpointMethods = { /** * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ deletePackageVersionForOrg: { ( @@ -7267,9 +7742,9 @@ export type RestEndpointMethods = { /** * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ deletePackageVersionForUser: { ( @@ -7283,7 +7758,7 @@ export type RestEndpointMethods = { /** * Lists package versions for a package owned by an organization. * - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." * @deprecated octokit.rest.packages.getAllPackageVersionsForAPackageOwnedByAnOrg() has been renamed to octokit.rest.packages.getAllPackageVersionsForPackageOwnedByOrg() (2021-03-24) */ getAllPackageVersionsForAPackageOwnedByAnOrg: { @@ -7298,7 +7773,7 @@ export type RestEndpointMethods = { /** * Lists package versions for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." * @deprecated octokit.rest.packages.getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser() has been renamed to octokit.rest.packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser() (2021-03-24) */ getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser: { @@ -7313,7 +7788,7 @@ export type RestEndpointMethods = { /** * Lists package versions for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ getAllPackageVersionsForPackageOwnedByAuthenticatedUser: { ( @@ -7327,7 +7802,7 @@ export type RestEndpointMethods = { /** * Lists package versions for a package owned by an organization. * - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ getAllPackageVersionsForPackageOwnedByOrg: { ( @@ -7341,7 +7816,7 @@ export type RestEndpointMethods = { /** * Lists package versions for a public package owned by a specified user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ getAllPackageVersionsForPackageOwnedByUser: { ( @@ -7355,7 +7830,7 @@ export type RestEndpointMethods = { /** * Gets a specific package for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ getPackageForAuthenticatedUser: { ( @@ -7369,7 +7844,7 @@ export type RestEndpointMethods = { /** * Gets a specific package in an organization. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ getPackageForOrganization: { ( @@ -7383,7 +7858,7 @@ export type RestEndpointMethods = { /** * Gets a specific package metadata for a public package owned by a user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ getPackageForUser: { ( @@ -7397,7 +7872,7 @@ export type RestEndpointMethods = { /** * Gets a specific package version for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ getPackageVersionForAuthenticatedUser: { ( @@ -7411,7 +7886,7 @@ export type RestEndpointMethods = { /** * Gets a specific package version in an organization. * - * You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ getPackageVersionForOrganization: { ( @@ -7425,7 +7900,7 @@ export type RestEndpointMethods = { /** * Gets a specific package version for a public package owned by a specified user. * - * At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ getPackageVersionForUser: { ( @@ -7438,7 +7913,8 @@ export type RestEndpointMethods = { }; /** * Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ listDockerMigrationConflictingPackagesForAuthenticatedUser: { ( @@ -7451,7 +7927,8 @@ export type RestEndpointMethods = { }; /** * Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ listDockerMigrationConflictingPackagesForOrganization: { ( @@ -7464,7 +7941,8 @@ export type RestEndpointMethods = { }; /** * Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ listDockerMigrationConflictingPackagesForUser: { ( @@ -7478,7 +7956,7 @@ export type RestEndpointMethods = { /** * Lists packages owned by the authenticated user within the user's namespace. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ listPackagesForAuthenticatedUser: { ( @@ -7492,7 +7970,7 @@ export type RestEndpointMethods = { /** * Lists packages in an organization readable by the user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ listPackagesForOrganization: { ( @@ -7506,7 +7984,7 @@ export type RestEndpointMethods = { /** * Lists all packages in a user's namespace for which the requesting user has access. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ listPackagesForUser: { ( @@ -7524,7 +8002,7 @@ export type RestEndpointMethods = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ restorePackageForAuthenticatedUser: { ( @@ -7542,9 +8020,9 @@ export type RestEndpointMethods = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ restorePackageForOrg: { ( @@ -7562,9 +8040,9 @@ export type RestEndpointMethods = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ restorePackageForUser: { ( @@ -7582,7 +8060,7 @@ export type RestEndpointMethods = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ restorePackageVersionForAuthenticatedUser: { ( @@ -7600,9 +8078,9 @@ export type RestEndpointMethods = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ restorePackageVersionForOrg: { ( @@ -7620,9 +8098,9 @@ export type RestEndpointMethods = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ restorePackageVersionForUser: { ( @@ -7918,7 +8396,15 @@ export type RestEndpointMethods = { * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ create: { ( @@ -7930,7 +8416,15 @@ export type RestEndpointMethods = { /** * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ createReplyForReviewComment: { ( @@ -7942,13 +8436,22 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * Creates a review on a specified pull request. + * + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ createReview: { ( @@ -7958,13 +8461,21 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. + * Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." + * + * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ createReviewComment: { ( @@ -7977,6 +8488,13 @@ export type RestEndpointMethods = { }; /** * Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ deletePendingReview: { ( @@ -8000,7 +8518,18 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + * Dismisses a specified review on a pull request. + * + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), + * you must be a repository administrator or be included in the list of people or teams + * who can dismiss pull request reviews. + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ dismissReview: { ( @@ -8025,6 +8554,14 @@ export type RestEndpointMethods = { * * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ get: { ( @@ -8035,6 +8572,13 @@ export type RestEndpointMethods = { }; /** * Retrieves a pull request review by its ID. + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ getReview: { ( @@ -8044,7 +8588,14 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Provides details for a review comment. + * Provides details for a specified review comment. + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ getReviewComment: { ( @@ -8056,7 +8607,22 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Lists pull requests in a specified repository. + * + * Draft pull requests are available in public repositories with GitHub + * Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing + * plans, and in public and private repositories with GitHub Team and GitHub Enterprise + * Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) + * in the GitHub Help documentation. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + * - **`application/vnd.github.patch`**: For more information, see "[git-format-patch](https://git-scm.com/docs/git-format-patch)" in the Git documentation. */ list: { ( @@ -8066,7 +8632,14 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List comments for a specific pull request review. + * Lists comments for a specific pull request review. + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ listCommentsForReview: { ( @@ -8078,7 +8651,17 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. + * Lists a maximum of 250 commits for a pull request. To receive a complete + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) + * endpoint. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ listCommits: { ( @@ -8088,7 +8671,18 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. + * Lists the files in a specified pull request. + * + * **Note:** Responses include a maximum of 3000 files. The paginated response + * returns 30 files per page by default. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ listFiles: { ( @@ -8110,7 +8704,15 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all review comments for a pull request. By default, review comments are in ascending order by ID. + * Lists all review comments for a specified pull request. By default, review comments + * are in ascending order by ID. + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ listReviewComments: { ( @@ -8122,7 +8724,15 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. + * Lists review comments for all pull requests in a repository. By default, + * review comments are in ascending order by ID. + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ listReviewCommentsForRepo: { ( @@ -8134,7 +8744,14 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * The list of reviews returns in chronological order. + * Lists all reviews for a specified pull request. The list of reviews returns in chronological order. + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ listReviews: { ( @@ -8145,7 +8762,7 @@ export type RestEndpointMethods = { }; /** * Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ merge: { ( @@ -8180,6 +8797,13 @@ export type RestEndpointMethods = { }; /** * Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ submitReview: { ( @@ -8192,6 +8816,14 @@ export type RestEndpointMethods = { * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + * + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ update: { ( @@ -8211,7 +8843,14 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Update the review summary comment with new text. + * Updates the contents of a specified review summary comment. + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ updateReview: { ( @@ -8221,7 +8860,14 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Enables you to edit a review comment. + * Edits the content of a specified review comment. + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ updateReviewComment: { ( @@ -8239,7 +8885,7 @@ export type RestEndpointMethods = { * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." @@ -8320,9 +8966,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ createForTeamDiscussionCommentInOrg: { ( @@ -8334,9 +8984,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ createForTeamDiscussionInOrg: { ( @@ -8420,7 +9074,9 @@ export type RestEndpointMethods = { /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ deleteForTeamDiscussion: { ( @@ -8434,7 +9090,9 @@ export type RestEndpointMethods = { /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ deleteForTeamDiscussionComment: { ( @@ -8506,9 +9164,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ listForTeamDiscussionCommentInOrg: { ( @@ -8520,9 +9180,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ listForTeamDiscussionInOrg: { ( @@ -8560,7 +9222,7 @@ export type RestEndpointMethods = { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ addAppAccessRestrictions: { ( @@ -8572,7 +9234,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * @@ -8582,7 +9244,7 @@ export type RestEndpointMethods = { * Cannot assign {member} permission of {role name} * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * @@ -8647,6 +9309,20 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Cancels a GitHub Pages deployment. + * + * The authenticated user must have write permissions for the GitHub Pages site. + */ + cancelPagesDeployment: { + ( + params?: RestEndpointMethodTypes["repos"]["cancelPagesDeployment"]["parameters"], + ): Promise< + RestEndpointMethodTypes["repos"]["cancelPagesDeployment"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". */ @@ -8664,9 +9340,9 @@ export type RestEndpointMethods = { * * Team members will include the members of child teams. * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. + * The authenticated user must have push access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ checkCollaborator: { ( @@ -8759,7 +9435,12 @@ export type RestEndpointMethods = { /** * 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)." * - * 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. You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * 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. + * + * This 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)." + * + * - **`application/vnd.github.diff`**: Returns the diff of the commit. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. * * The 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. * @@ -8827,7 +9508,14 @@ export type RestEndpointMethods = { /** * Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ createCommitComment: { ( @@ -8905,8 +9593,6 @@ export type RestEndpointMethods = { * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an * application with debugging enabled. * - * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. - * * Merged branch response: * * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating @@ -8927,6 +9613,8 @@ export type RestEndpointMethods = { * * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ createDeployment: { ( @@ -8940,7 +9628,7 @@ export type RestEndpointMethods = { /** * Creates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createDeploymentBranchPolicy: { ( @@ -8954,9 +9642,11 @@ export type RestEndpointMethods = { /** * Enable a custom deployment protection rule for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createDeploymentProtectionRule: { ( @@ -8970,7 +9660,7 @@ export type RestEndpointMethods = { /** * Users with `push` access can create deployment statuses for a given deployment. * - * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. */ createDeploymentStatus: { ( @@ -8986,12 +9676,9 @@ export type RestEndpointMethods = { * * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * - * This endpoint requires write access to the repository by providing either: - * - * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. - * * This input example shows how you can use the `client_payload` as a test to debug your workflow. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createDispatchEvent: { ( @@ -9005,12 +9692,7 @@ export type RestEndpointMethods = { /** * Creates a new repository for the authenticated user. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ createForAuthenticatedUser: { ( @@ -9038,12 +9720,7 @@ export type RestEndpointMethods = { /** * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ createInOrg: { ( @@ -9052,6 +9729,21 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Create new or update existing custom property values for a repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + */ + createOrUpdateCustomPropertiesValues: { + ( + params?: RestEndpointMethodTypes["repos"]["createOrUpdateCustomPropertiesValues"]["parameters"], + ): Promise< + RestEndpointMethodTypes["repos"]["createOrUpdateCustomPropertiesValues"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * @@ -9059,7 +9751,7 @@ export type RestEndpointMethods = { * * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createOrUpdateEnvironment: { ( @@ -9071,9 +9763,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. + * Creates a new file or replaces an existing file in a repository. * * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ createOrUpdateFileContents: { ( @@ -9099,7 +9793,7 @@ export type RestEndpointMethods = { /** * Create a GitHub Pages deployment for a repository. * - * Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint. + * The authenticated user must have write permission to the repository. */ createPagesDeployment: { ( @@ -9113,7 +9807,9 @@ export type RestEndpointMethods = { /** * Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ createPagesSite: { ( @@ -9127,7 +9823,7 @@ export type RestEndpointMethods = { /** * Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ createRelease: { ( @@ -9164,12 +9860,7 @@ export type RestEndpointMethods = { /** * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ createUsingTemplate: { ( @@ -9214,10 +9905,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + * Deleting a repository requires admin access. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. + * + * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. */ delete: { ( @@ -9255,7 +9948,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * You must authenticate using an access token with the repo scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteAnEnvironment: { ( @@ -9329,7 +10022,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. + * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. * * To set a deployment as inactive, you must: * @@ -9337,6 +10030,8 @@ export type RestEndpointMethods = { * * Mark the active deployment as inactive by adding any non-successful deployment status. * * For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ deleteDeployment: { ( @@ -9350,7 +10045,7 @@ export type RestEndpointMethods = { /** * Deletes a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deleteDeploymentBranchPolicy: { ( @@ -9404,7 +10099,9 @@ export type RestEndpointMethods = { /** * Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ deletePagesSite: { ( @@ -9495,7 +10192,9 @@ export type RestEndpointMethods = { /** * Disables a custom deployment protection rule for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)". + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ disableDeploymentProtectionRule: { ( @@ -9669,9 +10368,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ getAllDeploymentProtectionRules: { ( @@ -9685,7 +10386,9 @@ export type RestEndpointMethods = { /** * Lists the environments for a repository. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ getAllEnvironments: { ( @@ -9719,7 +10422,7 @@ export type RestEndpointMethods = { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ getAppsWithAccessToProtectedBranch: { ( @@ -9789,6 +10492,9 @@ export type RestEndpointMethods = { }; /** * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * + * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains + * 10,000 or more commits, a 422 status code will be returned. */ getCodeFrequencyStats: { ( @@ -9839,11 +10545,13 @@ export type RestEndpointMethods = { /** * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. + * This 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)." Pagination query parameters are not supported for these media types. * - * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. * * **Signature verification object** * @@ -9893,7 +10601,16 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Gets a specified commit comment. + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ getCommitComment: { ( params?: RestEndpointMethodTypes["repos"]["getCommitComment"]["parameters"], @@ -9942,43 +10659,31 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit - * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. + * Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. * - * Files and symlinks support [a custom media type](https://docs.github.com/rest/overview/media-types) for - * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media - * type](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent - * object format. + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. + * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + * + * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". + * + * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + * + * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. * * **Notes**: - * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). - * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees - * API](https://docs.github.com/rest/git/trees#get-a-tree). - * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * Size limits: - * If the requested file's size is: - * * 1 MB or smaller: All features of this endpoint are supported. - * * Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * * Greater than 100 MB: This endpoint is not supported. - * - * If the content is a directory: - * The response will be an array of objects, one object for each item in the directory. - * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value - * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). - * In the next major version of the API, the type will be returned as "submodule". - * - * If the content is a symlink: - * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the - * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object - * describing the symlink itself. - * - * If the content is a submodule: - * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific - * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out - * the submodule at that specific commit. - * - * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the - * github.com URLs (`html_url` and `_links["html"]`) will have null values. + * + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). + * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + * more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). + * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + * - If the requested file's size is: + * - 1 MB or smaller: All features of this endpoint are supported. + * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + * - Greater than 100 MB: This endpoint is not supported. */ getContent: { ( @@ -9990,10 +10695,12 @@ export type RestEndpointMethods = { /** * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * - * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). * * `a` - Number of additions * * `d` - Number of deletions * * `c` - Number of commits + * + * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ getContributorsStats: { ( @@ -10005,9 +10712,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ getCustomDeploymentProtectionRule: { ( @@ -10050,7 +10759,9 @@ export type RestEndpointMethods = { /** * Gets a deployment branch or tag policy for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ getDeploymentBranchPolicy: { ( @@ -10076,9 +10787,9 @@ export type RestEndpointMethods = { /** * **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * - * Anyone with read access to the repository can use this endpoint. If the - * repository is private, you must use an access token with the `repo` scope. GitHub - * Apps must have the `actions:read` permission to use this endpoint. + * 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. */ getEnvironment: { ( @@ -10092,7 +10803,7 @@ export type RestEndpointMethods = { /** * Gets information about the single most recent build of a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getLatestPagesBuild: { ( @@ -10168,7 +10879,7 @@ export type RestEndpointMethods = { /** * Gets information about a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getPages: { ( @@ -10180,7 +10891,7 @@ export type RestEndpointMethods = { /** * Gets information about a GitHub Pages build. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getPagesBuild: { ( @@ -10189,12 +10900,28 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Gets the current status of a GitHub Pages deployment. + * + * The authenticated user must have read permission for the GitHub Pages site. + */ + getPagesDeployment: { + ( + params?: RestEndpointMethodTypes["repos"]["getPagesDeployment"]["parameters"], + ): Promise< + RestEndpointMethodTypes["repos"]["getPagesDeployment"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. * * The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getPagesHealthCheck: { ( @@ -10254,7 +10981,10 @@ export type RestEndpointMethods = { /** * Gets the preferred README for a repository. * - * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ getReadme: { ( @@ -10266,7 +10996,10 @@ export type RestEndpointMethods = { /** * Gets the README from a repository directory. * - * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + * This 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)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ getReadmeInDirectory: { ( @@ -10278,7 +11011,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). + * Gets a public release with the specified release ID. + * + * **Note:** This returns an `upload_url` key corresponding to the endpoint + * for uploading release assets. This key is a hypermedia resource. For more information, see + * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ getRelease: { ( @@ -10446,7 +11183,7 @@ export type RestEndpointMethods = { /** * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * - * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. */ getWebhookConfigForRepo: { ( @@ -10485,7 +11222,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This returns a list of autolinks configured for the given repository. + * Gets all autolinks that are configured for a repository. * * Information about autolinks are only available to repository administrators. */ @@ -10524,9 +11261,9 @@ export type RestEndpointMethods = { * * Team members will include the members of child teams. * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. + * The authenticated user must have push access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ listCollaborators: { ( @@ -10538,7 +11275,14 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Use the `:commit_sha` to specify the commit that will have its comments listed. + * Lists the comments for a specified commit. + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ listCommentsForCommit: { ( @@ -10550,9 +11294,14 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * Lists the commit comments for a specified repository. Comments are ordered by ascending ID. * - * Comments are ordered by ascending ID. + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ listCommitCommentsForRepo: { ( @@ -10629,11 +11378,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. + * Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ listCustomDeploymentRuleIntegrations: { ( @@ -10657,7 +11408,9 @@ export type RestEndpointMethods = { /** * Lists the deployment branch policies for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ listDeploymentBranchPolicies: { ( @@ -10719,7 +11472,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. + * Lists public repositories for the specified user. */ listForUser: { ( @@ -10773,7 +11526,7 @@ export type RestEndpointMethods = { /** * Lists builts of a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ listPagesBuilds: { ( @@ -10861,11 +11614,7 @@ export type RestEndpointMethods = { * * For a public repository, a team is listed only if that team added the public repository explicitly. * - * Personal access tokens require the following scopes: - * * `public_repo` to call this endpoint on a public repository - * * `repo` to call this endpoint on a private repository (this scope also includes public repositories) - * - * This endpoint is not compatible with fine-grained personal access tokens. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. */ listTeams: { ( @@ -10939,7 +11688,7 @@ export type RestEndpointMethods = { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ removeAppAccessRestrictions: { ( @@ -11043,17 +11792,9 @@ export type RestEndpointMethods = { * * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". * - * The permissions required to use this endpoint depends on whether you are renaming the default branch. - * - * To rename a non-default branch: - * - * * Users must have push access. - * * GitHub Apps must have the `contents:write` repository permission. - * - * To rename the default branch: + * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * - * * Users must have admin or owner permissions. - * * GitHub Apps must have the `administration:write` repository permission. + * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. */ renameBranch: { ( @@ -11103,7 +11844,7 @@ export type RestEndpointMethods = { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ setAppAccessRestrictions: { ( @@ -11174,7 +11915,6 @@ export type RestEndpointMethods = { }; /** * A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). - * You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. */ transfer: { ( @@ -11211,7 +11951,16 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Updates the contents of a specified commit comment. + * + * This 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)." + * + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ updateCommitComment: { ( params?: RestEndpointMethodTypes["repos"]["updateCommitComment"]["parameters"], @@ -11224,7 +11973,7 @@ export type RestEndpointMethods = { /** * Updates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ updateDeploymentBranchPolicy: { ( @@ -11238,7 +11987,9 @@ export type RestEndpointMethods = { /** * Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ updateInformationAboutPagesSite: { ( @@ -11363,7 +12114,7 @@ export type RestEndpointMethods = { /** * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * - * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. */ updateWebhookConfigForRepo: { ( @@ -11375,7 +12126,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in + * This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset. * * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. @@ -11407,7 +12158,7 @@ export type RestEndpointMethods = { }; search: { /** - * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -11436,7 +12187,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match * metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -11453,7 +12204,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -11476,7 +12227,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -11494,7 +12245,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -11512,7 +12263,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -11530,7 +12281,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -11553,10 +12304,10 @@ export type RestEndpointMethods = { secretScanning: { /** * Gets a single secret scanning alert detected in an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ getAlert: { ( @@ -11569,7 +12320,12 @@ export type RestEndpointMethods = { }; /** * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * + * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * + * The authenticated user must be a member of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. */ listAlertsForEnterprise: { ( @@ -11582,10 +12338,10 @@ export type RestEndpointMethods = { }; /** * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ listAlertsForOrg: { ( @@ -11598,10 +12354,10 @@ export type RestEndpointMethods = { }; /** * Lists secret scanning alerts for an eligible repository, from newest to oldest. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ listAlertsForRepo: { ( @@ -11614,10 +12370,10 @@ export type RestEndpointMethods = { }; /** * Lists all locations for a given secret scanning alert for an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ listLocationsForAlert: { ( @@ -11630,10 +12386,10 @@ export type RestEndpointMethods = { }; /** * Updates the status of a secret scanning alert in an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ updateAlert: { ( @@ -11646,6 +12402,20 @@ export type RestEndpointMethods = { }; }; securityAdvisories: { + /** + * Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. + * + * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + */ + createFork: { + ( + params?: RestEndpointMethodTypes["securityAdvisories"]["createFork"]["parameters"], + ): Promise< + RestEndpointMethodTypes["securityAdvisories"]["createFork"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Report a security vulnerability to the maintainers of the repository. * See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. @@ -11661,9 +12431,10 @@ export type RestEndpointMethods = { }; /** * Creates a new repository security advisory. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. * - * In order to create a draft repository security advisory, you must be a security manager or administrator of that repository. + * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ createRepositoryAdvisory: { ( @@ -11679,9 +12450,9 @@ export type RestEndpointMethods = { * * You may request a CVE for public repositories, but cannot do so for private repositories. * - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + * In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. * - * In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ createRepositoryAdvisoryCveRequest: { ( @@ -11706,12 +12477,13 @@ export type RestEndpointMethods = { }; /** * Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * You can access any published security advisory on a public repository. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - * in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to. * - * You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a + * Anyone can access any published security advisory on a public repository. + * + * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a * collaborator on the security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ getRepositoryAdvisory: { ( @@ -11739,7 +12511,9 @@ export type RestEndpointMethods = { /** * Lists repository security advisories for an organization. * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ listOrgRepositoryAdvisories: { ( @@ -11752,10 +12526,10 @@ export type RestEndpointMethods = { }; /** * Lists security advisories in a repository. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - * in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to. * - * You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory. + * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ listRepositoryAdvisories: { ( @@ -11768,10 +12542,11 @@ export type RestEndpointMethods = { }; /** * Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. * - * In order to update any security advisory, you must be a security manager or administrator of that repository, + * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, * or a collaborator on the repository security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ updateRepositoryAdvisory: { ( @@ -11821,7 +12596,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * @@ -11857,6 +12632,8 @@ export type RestEndpointMethods = { * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * + * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. + * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ checkPermissionsForRepoInOrg: { @@ -11881,11 +12658,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ createDiscussionCommentInOrg: { ( @@ -11897,11 +12676,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ createDiscussionInOrg: { ( @@ -11913,9 +12694,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Deletes a comment on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ deleteDiscussionCommentInOrg: { ( @@ -11927,9 +12710,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a discussion from a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ deleteDiscussionInOrg: { ( @@ -11967,9 +12752,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Get a specific comment on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ getDiscussionCommentInOrg: { ( @@ -11981,9 +12768,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Get a specific discussion on a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ getDiscussionInOrg: { ( @@ -12040,9 +12829,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List all comments on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ listDiscussionCommentsInOrg: { ( @@ -12054,9 +12845,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List all discussions on a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ listDiscussionsInOrg: { ( @@ -12068,7 +12861,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. + * List all of the teams across all of the organizations to which the authenticated + * user belongs. + * + * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + * + * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. */ listForAuthenticatedUser: { ( @@ -12182,9 +12980,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Edits the body text of a discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ updateDiscussionCommentInOrg: { ( @@ -12196,9 +12996,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ updateDiscussionInOrg: { ( @@ -12224,7 +13026,7 @@ export type RestEndpointMethods = { }; users: { /** - * This endpoint is accessible with the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. * @deprecated octokit.rest.users.addEmailForAuthenticated() has been renamed to octokit.rest.users.addEmailForAuthenticatedUser() (2021-10-05) */ addEmailForAuthenticated: { @@ -12237,7 +13039,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint is accessible with the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ addEmailForAuthenticatedUser: { ( @@ -12249,7 +13051,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. + * Add one or more social accounts to the authenticated user's profile. + * + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ addSocialAccountForAuthenticatedUser: { ( @@ -12301,7 +13105,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Adds a GPG key to the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. * @deprecated octokit.rest.users.createGpgKeyForAuthenticated() has been renamed to octokit.rest.users.createGpgKeyForAuthenticatedUser() (2021-10-05) */ createGpgKeyForAuthenticated: { @@ -12314,7 +13120,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Adds a GPG key to the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ createGpgKeyForAuthenticatedUser: { ( @@ -12326,7 +13134,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Adds a public SSH key to the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. * @deprecated octokit.rest.users.createPublicSshKeyForAuthenticated() has been renamed to octokit.rest.users.createPublicSshKeyForAuthenticatedUser() (2021-10-05) */ createPublicSshKeyForAuthenticated: { @@ -12339,7 +13149,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Adds a public SSH key to the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ createPublicSshKeyForAuthenticatedUser: { ( @@ -12351,7 +13163,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * Creates an SSH signing key for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. */ createSshSigningKeyForAuthenticatedUser: { ( @@ -12363,7 +13177,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint is accessible with the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. * @deprecated octokit.rest.users.deleteEmailForAuthenticated() has been renamed to octokit.rest.users.deleteEmailForAuthenticatedUser() (2021-10-05) */ deleteEmailForAuthenticated: { @@ -12376,7 +13190,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint is accessible with the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ deleteEmailForAuthenticatedUser: { ( @@ -12388,7 +13202,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Removes a GPG key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. * @deprecated octokit.rest.users.deleteGpgKeyForAuthenticated() has been renamed to octokit.rest.users.deleteGpgKeyForAuthenticatedUser() (2021-10-05) */ deleteGpgKeyForAuthenticated: { @@ -12401,7 +13217,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Removes a GPG key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. */ deleteGpgKeyForAuthenticatedUser: { ( @@ -12413,7 +13231,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Removes a public SSH key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. * @deprecated octokit.rest.users.deletePublicSshKeyForAuthenticated() has been renamed to octokit.rest.users.deletePublicSshKeyForAuthenticatedUser() (2021-10-05) */ deletePublicSshKeyForAuthenticated: { @@ -12426,7 +13246,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Removes a public SSH key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. */ deletePublicSshKeyForAuthenticatedUser: { ( @@ -12438,7 +13260,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope. + * Deletes one or more social accounts from the authenticated user's profile. + * + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ deleteSocialAccountForAuthenticatedUser: { ( @@ -12450,7 +13274,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * Deletes an SSH signing key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. */ deleteSshSigningKeyForAuthenticatedUser: { ( @@ -12462,9 +13288,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ follow: { ( @@ -12474,9 +13300,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. - * - * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + * OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. */ getAuthenticated: { ( @@ -12490,9 +13314,7 @@ export type RestEndpointMethods = { /** * Provides publicly available information about someone with a GitHub account. * - * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" - * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". */ @@ -12504,7 +13326,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + * 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: * @@ -12512,6 +13334,8 @@ export type RestEndpointMethods = { * curl -u username:token * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 * ``` + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getContextForUser: { ( @@ -12523,7 +13347,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * View extended details for a single GPG key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. * @deprecated octokit.rest.users.getGpgKeyForAuthenticated() has been renamed to octokit.rest.users.getGpgKeyForAuthenticatedUser() (2021-10-05) */ getGpgKeyForAuthenticated: { @@ -12536,7 +13362,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * View extended details for a single GPG key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ getGpgKeyForAuthenticatedUser: { ( @@ -12548,7 +13376,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * View extended details for a single public SSH key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. * @deprecated octokit.rest.users.getPublicSshKeyForAuthenticated() has been renamed to octokit.rest.users.getPublicSshKeyForAuthenticatedUser() (2021-10-05) */ getPublicSshKeyForAuthenticated: { @@ -12561,7 +13391,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * View extended details for a single public SSH key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ getPublicSshKeyForAuthenticatedUser: { ( @@ -12573,7 +13405,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * Gets extended details for an SSH signing key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ getSshSigningKeyForAuthenticatedUser: { ( @@ -12622,7 +13456,10 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + * Lists all of your email addresses, and specifies which one is visible + * to the public. + * + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. * @deprecated octokit.rest.users.listEmailsForAuthenticated() has been renamed to octokit.rest.users.listEmailsForAuthenticatedUser() (2021-10-05) */ listEmailsForAuthenticated: { @@ -12635,7 +13472,10 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + * Lists all of your email addresses, and specifies which one is visible + * to the public. + * + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ listEmailsForAuthenticatedUser: { ( @@ -12708,7 +13548,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Lists the current user's GPG keys. + * + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. * @deprecated octokit.rest.users.listGpgKeysForAuthenticated() has been renamed to octokit.rest.users.listGpgKeysForAuthenticatedUser() (2021-10-05) */ listGpgKeysForAuthenticated: { @@ -12721,7 +13563,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Lists the current user's GPG keys. + * + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ listGpgKeysForAuthenticatedUser: { ( @@ -12745,7 +13589,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + * Lists your publicly visible email address, which you can set with the + * [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. * @deprecated octokit.rest.users.listPublicEmailsForAuthenticated() has been renamed to octokit.rest.users.listPublicEmailsForAuthenticatedUser() (2021-10-05) */ listPublicEmailsForAuthenticated: { @@ -12758,7 +13606,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + * Lists your publicly visible email address, which you can set with the + * [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ listPublicEmailsForAuthenticatedUser: { ( @@ -12782,7 +13634,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Lists the public SSH keys for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. * @deprecated octokit.rest.users.listPublicSshKeysForAuthenticated() has been renamed to octokit.rest.users.listPublicSshKeysForAuthenticatedUser() (2021-10-05) */ listPublicSshKeysForAuthenticated: { @@ -12795,7 +13649,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Lists the public SSH keys for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ listPublicSshKeysForAuthenticatedUser: { ( @@ -12831,7 +13687,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * Lists the SSH signing keys for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ listSshSigningKeysForAuthenticatedUser: { ( @@ -12890,7 +13748,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ unfollow: { ( diff --git a/src/generated/parameters-and-response-types.ts b/src/generated/parameters-and-response-types.ts index 077cc93ce..0168a3301 100644 --- a/src/generated/parameters-and-response-types.ts +++ b/src/generated/parameters-and-response-types.ts @@ -747,6 +747,11 @@ export type RestEndpointMethodTypes = { Endpoints["PUT /repos/{owner}/{repo}/notifications"]["parameters"]; response: Endpoints["PUT /repos/{owner}/{repo}/notifications"]["response"]; }; + markThreadAsDone: { + parameters: RequestParameters & + Endpoints["DELETE /notifications/threads/{thread_id}"]["parameters"]; + response: Endpoints["DELETE /notifications/threads/{thread_id}"]["response"]; + }; markThreadAsRead: { parameters: RequestParameters & Endpoints["PATCH /notifications/threads/{thread_id}"]["parameters"]; @@ -1380,12 +1385,12 @@ export type RestEndpointMethodTypes = { }; }; copilot: { - addCopilotForBusinessSeatsForTeams: { + addCopilotSeatsForTeams: { parameters: RequestParameters & Endpoints["POST /orgs/{org}/copilot/billing/selected_teams"]["parameters"]; response: Endpoints["POST /orgs/{org}/copilot/billing/selected_teams"]["response"]; }; - addCopilotForBusinessSeatsForUsers: { + addCopilotSeatsForUsers: { parameters: RequestParameters & Endpoints["POST /orgs/{org}/copilot/billing/selected_users"]["parameters"]; response: Endpoints["POST /orgs/{org}/copilot/billing/selected_users"]["response"]; @@ -2150,6 +2155,16 @@ export type RestEndpointMethodTypes = { Endpoints["PUT /orgs/{org}/security-managers/teams/{team_slug}"]["parameters"]; response: Endpoints["PUT /orgs/{org}/security-managers/teams/{team_slug}"]["response"]; }; + assignTeamToOrgRole: { + parameters: RequestParameters & + Endpoints["PUT /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}"]["parameters"]; + response: Endpoints["PUT /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}"]["response"]; + }; + assignUserToOrgRole: { + parameters: RequestParameters & + Endpoints["PUT /orgs/{org}/organization-roles/users/{username}/{role_id}"]["parameters"]; + response: Endpoints["PUT /orgs/{org}/organization-roles/users/{username}/{role_id}"]["response"]; + }; blockUser: { parameters: RequestParameters & Endpoints["PUT /orgs/{org}/blocks/{username}"]["parameters"]; @@ -2180,6 +2195,11 @@ export type RestEndpointMethodTypes = { Endpoints["PUT /orgs/{org}/outside_collaborators/{username}"]["parameters"]; response: Endpoints["PUT /orgs/{org}/outside_collaborators/{username}"]["response"]; }; + createCustomOrganizationRole: { + parameters: RequestParameters & + Endpoints["POST /orgs/{org}/organization-roles"]["parameters"]; + response: Endpoints["POST /orgs/{org}/organization-roles"]["response"]; + }; createInvitation: { parameters: RequestParameters & Endpoints["POST /orgs/{org}/invitations"]["parameters"]; @@ -2210,6 +2230,11 @@ export type RestEndpointMethodTypes = { Endpoints["DELETE /orgs/{org}"]["parameters"]; response: Endpoints["DELETE /orgs/{org}"]["response"]; }; + deleteCustomOrganizationRole: { + parameters: RequestParameters & + Endpoints["DELETE /orgs/{org}/organization-roles/{role_id}"]["parameters"]; + response: Endpoints["DELETE /orgs/{org}/organization-roles/{role_id}"]["response"]; + }; deleteWebhook: { parameters: RequestParameters & Endpoints["DELETE /orgs/{org}/hooks/{hook_id}"]["parameters"]; @@ -2245,6 +2270,11 @@ export type RestEndpointMethodTypes = { Endpoints["GET /orgs/{org}/memberships/{username}"]["parameters"]; response: Endpoints["GET /orgs/{org}/memberships/{username}"]["response"]; }; + getOrgRole: { + parameters: RequestParameters & + Endpoints["GET /orgs/{org}/organization-roles/{role_id}"]["parameters"]; + response: Endpoints["GET /orgs/{org}/organization-roles/{role_id}"]["response"]; + }; getWebhook: { parameters: RequestParameters & Endpoints["GET /orgs/{org}/hooks/{hook_id}"]["parameters"]; @@ -2309,6 +2339,26 @@ export type RestEndpointMethodTypes = { Endpoints["GET /user/memberships/orgs"]["parameters"]; response: Endpoints["GET /user/memberships/orgs"]["response"]; }; + listOrgRoleTeams: { + parameters: RequestParameters & + Endpoints["GET /orgs/{org}/organization-roles/{role_id}/teams"]["parameters"]; + response: Endpoints["GET /orgs/{org}/organization-roles/{role_id}/teams"]["response"]; + }; + listOrgRoleUsers: { + parameters: RequestParameters & + Endpoints["GET /orgs/{org}/organization-roles/{role_id}/users"]["parameters"]; + response: Endpoints["GET /orgs/{org}/organization-roles/{role_id}/users"]["response"]; + }; + listOrgRoles: { + parameters: RequestParameters & + Endpoints["GET /orgs/{org}/organization-roles"]["parameters"]; + response: Endpoints["GET /orgs/{org}/organization-roles"]["response"]; + }; + listOrganizationFineGrainedPermissions: { + parameters: RequestParameters & + Endpoints["GET /orgs/{org}/organization-fine-grained-permissions"]["parameters"]; + response: Endpoints["GET /orgs/{org}/organization-fine-grained-permissions"]["response"]; + }; listOutsideCollaborators: { parameters: RequestParameters & Endpoints["GET /orgs/{org}/outside_collaborators"]["parameters"]; @@ -2359,6 +2409,11 @@ export type RestEndpointMethodTypes = { Endpoints["GET /orgs/{org}/hooks"]["parameters"]; response: Endpoints["GET /orgs/{org}/hooks"]["response"]; }; + patchCustomOrganizationRole: { + parameters: RequestParameters & + Endpoints["PATCH /orgs/{org}/organization-roles/{role_id}"]["parameters"]; + response: Endpoints["PATCH /orgs/{org}/organization-roles/{role_id}"]["response"]; + }; pingWebhook: { parameters: RequestParameters & Endpoints["POST /orgs/{org}/hooks/{hook_id}/pings"]["parameters"]; @@ -2409,6 +2464,26 @@ export type RestEndpointMethodTypes = { Endpoints["POST /orgs/{org}/personal-access-token-requests"]["parameters"]; response: Endpoints["POST /orgs/{org}/personal-access-token-requests"]["response"]; }; + revokeAllOrgRolesTeam: { + parameters: RequestParameters & + Endpoints["DELETE /orgs/{org}/organization-roles/teams/{team_slug}"]["parameters"]; + response: Endpoints["DELETE /orgs/{org}/organization-roles/teams/{team_slug}"]["response"]; + }; + revokeAllOrgRolesUser: { + parameters: RequestParameters & + Endpoints["DELETE /orgs/{org}/organization-roles/users/{username}"]["parameters"]; + response: Endpoints["DELETE /orgs/{org}/organization-roles/users/{username}"]["response"]; + }; + revokeOrgRoleTeam: { + parameters: RequestParameters & + Endpoints["DELETE /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}"]["parameters"]; + response: Endpoints["DELETE /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}"]["response"]; + }; + revokeOrgRoleUser: { + parameters: RequestParameters & + Endpoints["DELETE /orgs/{org}/organization-roles/users/{username}/{role_id}"]["parameters"]; + response: Endpoints["DELETE /orgs/{org}/organization-roles/users/{username}/{role_id}"]["response"]; + }; setMembershipForUser: { parameters: RequestParameters & Endpoints["PUT /orgs/{org}/memberships/{username}"]["parameters"]; @@ -3016,6 +3091,11 @@ export type RestEndpointMethodTypes = { Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["parameters"]; response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; }; + cancelPagesDeployment: { + parameters: RequestParameters & + Endpoints["POST /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel"]["parameters"]; + response: Endpoints["POST /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel"]["response"]; + }; checkAutomatedSecurityFixes: { parameters: RequestParameters & Endpoints["GET /repos/{owner}/{repo}/automated-security-fixes"]["parameters"]; @@ -3111,6 +3191,11 @@ export type RestEndpointMethodTypes = { Endpoints["POST /orgs/{org}/repos"]["parameters"]; response: Endpoints["POST /orgs/{org}/repos"]["response"]; }; + createOrUpdateCustomPropertiesValues: { + parameters: RequestParameters & + Endpoints["PATCH /repos/{owner}/{repo}/properties/values"]["parameters"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/properties/values"]["response"]; + }; createOrUpdateEnvironment: { parameters: RequestParameters & Endpoints["PUT /repos/{owner}/{repo}/environments/{environment_name}"]["parameters"]; @@ -3128,8 +3213,8 @@ export type RestEndpointMethodTypes = { }; createPagesDeployment: { parameters: RequestParameters & - Endpoints["POST /repos/{owner}/{repo}/pages/deployment"]["parameters"]; - response: Endpoints["POST /repos/{owner}/{repo}/pages/deployment"]["response"]; + Endpoints["POST /repos/{owner}/{repo}/pages/deployments"]["parameters"]; + response: Endpoints["POST /repos/{owner}/{repo}/pages/deployments"]["response"]; }; createPagesSite: { parameters: RequestParameters & @@ -3521,6 +3606,11 @@ export type RestEndpointMethodTypes = { Endpoints["GET /repos/{owner}/{repo}/pages/builds/{build_id}"]["parameters"]; response: Endpoints["GET /repos/{owner}/{repo}/pages/builds/{build_id}"]["response"]; }; + getPagesDeployment: { + parameters: RequestParameters & + Endpoints["GET /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}"]["response"]; + }; getPagesHealthCheck: { parameters: RequestParameters & Endpoints["GET /repos/{owner}/{repo}/pages/health"]["parameters"]; @@ -4042,6 +4132,11 @@ export type RestEndpointMethodTypes = { }; }; securityAdvisories: { + createFork: { + parameters: RequestParameters & + Endpoints["POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks"]["parameters"]; + response: Endpoints["POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks"]["response"]; + }; createPrivateVulnerabilityReport: { parameters: RequestParameters & Endpoints["POST /repos/{owner}/{repo}/security-advisories/reports"]["parameters"];